Skip to main content
POST
Create Webhook

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
api_template
string<uuid>
required

UUID of the webhook template to use for processing

Example:

"488f4644-057d-41e7-9a74-72c040602647"

endpoint_url
string<uri>
required

The URL where webhook notifications will be sent

Example:

"https://example.com/webhook/assignment-processing"

secret_hash
string

Optional secret key for webhook authentication (will be encrypted)

Example:

"my-secret-key-123"

Response

Webhook created successfully.

id
string<uuid>
required

Unique identifier of the webhook

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

api_template
object
required

Webhook template details

endpoint_url
string<uri>
required

The URL where webhook notifications are sent

Example:

"https://example.com/webhook/assignment-processing"