Skip to content

Create a new webhook

POST
/webhook

Creates a new webhook configuration

Authorizations

Request Body required

object
name

The name of the webhook

string
description

The description of the webhook

string
url
required

The url of the webhook

string format: uri
enabledEvents
required

A list of event names that this webhook is configured to listen to

Array<string>

Responses

201

Webhook created successfully

object
webhookId

The unique id for the webhook

string format: uuid
name

The name of the webhook

string
description

The description of the webhook

string
url
required

The url of the webhook

string format: uri
enabledEvents
required

A list of event names that this webhook is configured to listen to

Array<string>
signingSecret

The secret used to sign the webhook payload

string
status

The status of the webhook

string
Allowed values: active paused disabled
lastTriggeredAt

The date and time the webhook was last triggered

string format: date-time
createdAt

The date and time the webhook was created

string format: date-time

400

Bad Request

object
code
required

HTTP status code

integer
status
required

Error status message

string

401

Unauthorized

object
code
required

HTTP status code

integer
status
required

Error status message

string

500

Internal Server Error

object
code
required

HTTP status code

integer
status
required

Error status message

string