Webhooks

Update webhook

Update an existing webhook for the current workspace. All fields are optional—only include the fields you want to update.

patch/webhooks/{id}

Request

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

idstring uuid required

The unique identifier of the webhook to update

namestring

The name of the webhook

urlstring uri

The URL that will receive webhook events

descriptionstring

An optional description for the webhook

topicsstring[]

The event types this webhook should listen to

headersobject

Optional custom headers to include in webhook requests

Webhook updated

idstring uuid

namestring

urlstring uri

descriptionstring nullable

headersobject nullable

topicsstring[]

createdAtstring date-time

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