Webhooks

Download OpenAPI specification:Download

Subscribe to webhooks to get notified of specific events. Webhooks provide instant, real-time notifications, without requiring you to send API calls at regular time internals in order to detect changes in data.

Create webhook

Create a new webhook to listen for selected events. Created webhooks need to be verified and then enabled before they can be used

SecurityOAuth2: ClientAccessToken
Request
Request Body schema: application/json
required
uri
required
string

URL to which notifications are sent

api_key
required
string

Used to authenticate notifications (sent via X-API-Key header)

subscribed_events
Array of strings
Items Enum: "User created" "User updated" "User deleted" "User removed from app" "User added to app" "User suspended" "User unsuspended" "User password lock" "User requested deletion" "User logged in" "Orchestrated user login" "User logged out" "Failed OTP attempt"
name
string

Friendly name of the webhook

description
string

Description of the webhook

Responses
201
400
post/v1/webhooks
Request samples
application/json
{
  • "uri": "string",
  • "api_key": "string",
  • "subscribed_events": [
    ],
  • "name": "string",
  • "description": "string"
}
Response samples
application/json
{
  • "result": {
    }
}

Get all webhooks

Get a list of all configured webhooks

SecurityOAuth2: ClientAccessToken
Responses
200
400
get/v1/webhooks
Request samples
Response samples
application/json
{
  • "result": [
    ]
}

Get webhook by ID

Get a webhook with a given ID

SecurityOAuth2: ClientAccessToken
Request
path Parameters
webhook_id
required
string

The ID of the webhook to search for

Responses
200
400
get/v1/webhooks/{webhook_id}
Request samples
Response samples
application/json
{
  • "result": {
    }
}

Update webhook

Update a webhook with a given ID

SecurityOAuth2: ClientAccessToken
Request
path Parameters
webhook_id
required
string

The ID of the webhook to update

Request Body schema: application/json
required
api_key
string

Used to authenticate notifications (sent via X-API-Key header)

subscribed_events
Array of strings
Items Enum: "User created" "User updated" "User deleted" "User removed from app" "User added to app" "User suspended" "User unsuspended" "User password lock" "User requested deletion" "User logged in" "Orchestrated user login" "User logged out" "Failed OTP attempt"
name
string

Friendly name of the webhook

description
string

Description of the webhook

Responses
200
400
put/v1/webhooks/{webhook_id}
Request samples
application/json
{
  • "api_key": "string",
  • "subscribed_events": [
    ],
  • "name": "string",
  • "description": "string"
}
Response samples
application/json
{
  • "result": {
    }
}

Enable or disable webhook

Enables or disables a webhook for the given ID

SecurityOAuth2: ClientAccessToken
Request
path Parameters
webhook_id
required
string

The ID of the webhook to enable or disable

Request Body schema: application/json
required
enabled
required
boolean

Indicates whether the webhook should be enabled

Responses
204
400
patch/v1/webhooks/{webhook_id}
Request samples
application/json
{
  • "enabled": true
}
Response samples
application/json
{
  • "message": "Bad request",
  • "error_code": 400
}

Delete webhook

Delete a webhook with a given ID

SecurityOAuth2: ClientAccessToken
Request
path Parameters
webhook_id
required
string

The ID of the webhook to delete

Responses
204
400
delete/v1/webhooks/{webhook_id}
Request samples
Response samples
application/json
{
  • "message": "Bad request",
  • "error_code": 400
}

Verify webhook

Triggers a flow that verifies you own the webhook resource. When triggered, a GET request with an X-Verification-Key header is sent to the webhook URL, and your resource must respond with a key field that contains the X-Verification-Key header value.

SecurityOAuth2: ClientAccessToken
Request
path Parameters
webhook_id
required
string

The ID of the webhook to verify

Responses
200
400
post/v1/webhooks/verify/{webhook_id}
Request samples
Response samples
application/json
{
  • "result": {
    }
}