Webhooks

Subscribe to an event

Creates a new subscription.

post/webhooks

Request

Base URL
https://api.dojo.tech
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/dojo/apis/dojo-api/docs/webhooks/post.ts
A function with typed inputs. Its response is checked against the schema.

versionstring date required

The API version with format yyyy-mm-dd. The current version is 2026-02-27.

eventsstring[] required

The list of events.

urlstring uri required

The URL of the Webhook endpoint.

descriptionstring nullable

The subscription description.

{
  "events": [
    "payment_intent.created",
    "payment.successful",
    "order.created"
  ],
  "url": "https://example.com/incoming-events"
}

idstring

The unique identifier for the subscription.

accountIdstring nullable

The unique identifier for the account.

eventsstring[]

The list of events.

urlstring uri

The URL of the Webhook endpoint.

descriptionstring nullable

The subscription description.

createdAtstring date-time

The creation date, in ISO 8601 UTC format.

updatedAtstring date-time

The timestamp of the update date, in ISO 8601 UTC format.

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