Path parameters
-
id
string Required The unique identifier of the hook.
Body
Required
-
tenantId
string Maximum length is
21
. -
name
string The updated name of the hook.
Minimum length is
1
, maximum length is256
. -
event
string | null Deprecated Use
events
instead.Values are
PostRegister
,PostSignIn
,PostResetPassword
,User.Created
,User.Deleted
,User.Data.Updated
,User.SuspensionStatus.Updated
,Role.Created
,Role.Deleted
,Role.Data.Updated
,Role.Scopes.Updated
,Scope.Created
,Scope.Deleted
,Scope.Data.Updated
,Organization.Created
,Organization.Deleted
,Organization.Data.Updated
,Organization.Membership.Updated
,OrganizationRole.Created
,OrganizationRole.Deleted
,OrganizationRole.Data.Updated
,OrganizationRole.Scopes.Updated
,OrganizationScope.Created
,OrganizationScope.Deleted
, orOrganizationScope.Data.Updated
. -
events
array[string] An array of updated hook events.
Values are
PostRegister
,PostSignIn
,PostResetPassword
,User.Created
,User.Deleted
,User.Data.Updated
,User.SuspensionStatus.Updated
,Role.Created
,Role.Deleted
,Role.Data.Updated
,Role.Scopes.Updated
,Scope.Created
,Scope.Deleted
,Scope.Data.Updated
,Organization.Created
,Organization.Deleted
,Organization.Data.Updated
,Organization.Membership.Updated
,OrganizationRole.Created
,OrganizationRole.Deleted
,OrganizationRole.Data.Updated
,OrganizationRole.Scopes.Updated
,OrganizationScope.Created
,OrganizationScope.Deleted
, orOrganizationScope.Data.Updated
. -
config
object -
enabled
boolean -
createdAt
number
curl \
--request PATCH 'https://[tenant_id].logto.app/api/hooks/{id}' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"tenantId":"string","name":"string","event":"PostRegister","events":["PostRegister"],"config":{"url":"string","headers":{"additionalProperty1":"string","additionalProperty2":"string"},"retries":42.0},"enabled":true,"createdAt":42.0}'
{
"tenantId": "string",
"name": "string",
"event": "PostRegister",
"events": [
"PostRegister"
],
"config": {
"url": "string",
"headers": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"retries": 42.0
},
"enabled": true,
"createdAt": 42.0
}
{
"tenantId": "string",
"id": "string",
"name": "string",
"event": "PostRegister",
"events": [
"PostRegister"
],
"config": {
"url": "string",
"headers": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"retries": 42.0
},
"signingKey": "string",
"enabled": true,
"createdAt": 42.0
}