Skip to main content
POST
Create webhook endpoint

Authorizations

Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Body

application/json
url
string
required

The HTTPS URL that Orb sends webhook events to.

Maximum string length: 2048
enabled_event_types
string[] | null

The webhook event types to send to this endpoint. If omitted or null, all event types are sent.

Response

Created

A newly created webhook endpoint, along with the secret used to sign its webhook events.

id
string
required

The Orb-assigned unique identifier for the webhook endpoint.

url
string
required

The HTTPS URL that Orb sends webhook events to.

enabled
boolean
required

Whether Orb sends webhook events to this endpoint.

enabled_event_types
string[] | null
required

The webhook event types sent to this endpoint. If null, all event types are sent.

created_at
string<date-time>
required

The time the webhook endpoint was created.

secret
string
required

The secret used to sign the webhook events sent to this endpoint. Only returned when the endpoint is created.