Create a hook

POST /api/hooks

Create a new hook with the given data.

application/json

Body Required

name string

The name of the hook.

Minimum length is 1, maximum length is 256.
event string 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, or OrganizationScope.Data.Updated.
events array[string]

An array of 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, or OrganizationScope.Data.Updated.
config object Required
Hide config attributes Show config attributes
- url string Required
- headers object
  Hide headers attributes Show headers attributes
  
  Additional properties
  
  key string
- retries number Deprecated
  
  Now the retry times is fixed to 3. Keep for backward compatibility.
enabled boolean
createdAt number

Responses

• 201

The hook was created successfully.
• 400

Bad Request
• 401

Unauthorized
• 403

Forbidden

POST /api/hooks

curl \
 -X POST https://[tenant_id].logto.app/api/hooks \
 -H "Content-Type: application/json" \
 -d '{"name":"string","event":"PostRegister","events":["PostRegister"],"config":{"url":"string","headers":{"key":"string"},"retries":42.0},"enabled":true,"createdAt":42.0}'

Request example

{
  "name": "string",
  "event": "PostRegister",
  "events": [
    "PostRegister"
  ],
  "config": {
    "url": "string",
    "headers": {
      "key": "string"
    },
    "retries": 42.0
  },
  "enabled": true,
  "createdAt": 42.0
}