webhooks

Create webhook

Create a new webhook

post/v1/webhook

Request

  • Base URL: https://api.test.deepalpha.dev
  • URL: https://api.test.deepalpha.dev/v1/webhook
  • Auth: one of:
    • OAuth 2 (client credentials, token URL /v1/auth/token)
    • HTTP bearer

Request body

eventstring required

Event name - three parts separated by '.', wildcards are allowed (e.g., 'qap..')

headersobject nullable

Headers for the webhook

is_activeboolean required

Whether the webhook is active

secretstring nullable

Secret for signing the webhook payload

urlstring required

URL of the webhook

Response

Successful response

eventstring
failuresinteger
headersobject nullable
idstring
is_activeboolean
secretstring nullable
urlstring

Changes

No recorded changes to this operation across all 1 revision of this API.