Webhooks

Create webhook

Create a webhook for the current workspace. The webhook will receive events for the specified topics.

post/webhooks

Request

Base URL
https://app.tryordinal.com/api/v1/company
Auth
HTTP bearer
TypeScript
https://skmtc.dev/tryordinal/apis/ordinal-agency-api/docs/webhooks/post.ts
A function with typed inputs. Its response is checked against the schema.

namestring required

The name of the webhook

urlstring uri required

The URL that will receive webhook events

descriptionstring

An optional description for the webhook

topicsstring[] required

The event types this webhook should listen to

headersobject

Optional custom headers to include in webhook requests

Webhook created

idstring uuid

namestring

urlstring uri

topicsstring[]

createdAtstring date-time

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