Skip to main content
POST
Subscribe to a rest hook

Authorizations

Authorization
string
header
default:Token token=<api-key>
required

API authentication using your community API secret. The value below is sent as the Authorization header verbatim, so paste the whole header value including the prefix: Token token=

Path Parameters

key
string
required

The rest hook key (for example user_registered, user_updated, user_deleted)

Body

application/json

Subscription payload wrapped in a rest_hook_subscription object

rest_hook_subscription
object
required

Response

The request failed validation, so no subscription was created. The errors are in the response body

errors
object
required