Skip to main content
POST
/
webhooks
Create a new database webhook
curl --request POST \
  --url https://{tenant_id}.hanko.io/admin/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "callback": "<string>",
  "events": [
    "user"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "callback": "<string>",
  "enabled": true,
  "failures": 1,
  "expires_at": "2023-11-07T05:31:56Z",
  "events": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "event": "user"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2022-09-14T12:15:09.788784Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your API key. Must only be used when using Hanko Cloud.

Body

application/json
​
callback
string<uri>
required
​
events
enum<string>[]
required
Minimum array length: 1
Available options:
user,
user.login,
user.create,
user.delete,
user.update,
user.update.email,
user.update.email.create,
user.update.email.delete,
user.update.email.primary,
user.update.username,
user.update.username.create,
user.update.username.delete,
user.update.username.update,
email.send

Response

Created

​
id
string<uuid>
​
callback
string<uri>
​
enabled
boolean
​
failures
integer
Required range: x >= 0
​
expires_at
string<date-time>
​
events
DatabaseWebhookEvent · object[]
​
created_at
string<date-time>
​
updated_at
string<date-time>

Time of last update of the audit log

Example:

"2022-09-14T12:15:09.788784Z"