Create webhook

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

POST/webhooks

Authorization

AuthorizationBearer token · headerrequired

API key authentication. Generate an API key from your workspace settings.

Request body

requiredapplication/json

namestringrequired

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

min items 1

headersobject

Optional custom headers to include in webhook requests

Responses

200

Webhook created

idstring<uuid>

namestring

urlstring<uri>

topicsstring[]

createdAtstring<date-time>

400

Bad Request - Invalid input parameters

codestring

messagestring

dataobject

Show properties

errorsobject

401

Unauthorized - Missing or invalid API key

codestring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X POST 'https://app.tryordinal.com/api/v1/webhooks' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "CRM Sync",
  "url": "https://example.com/webhooks/ordinal",
  "description": "Sync published posts to our CRM",
  "topics": [
    "post.published",
    "post.archived"
  ]
}'

const response = await fetch("https://app.tryordinal.com/api/v1/webhooks", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"CRM Sync\",\n  \"url\": \"https://example.com/webhooks/ordinal\",\n  \"description\": \"Sync published posts to our CRM\",\n  \"topics\": [\n    \"post.published\",\n    \"post.archived\"\n  ]\n}"
});

import requests

response = requests.post(
    "https://app.tryordinal.com/api/v1/webhooks",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"CRM Sync\",\n  \"url\": \"https://example.com/webhooks/ordinal\",\n  \"description\": \"Sync published posts to our CRM\",\n  \"topics\": [\n    \"post.published\",\n    \"post.archived\"\n  ]\n}",
)

Response

{
  "id": "550e8400-e29b-41d4-a716-446655440900",
  "name": "CRM Sync",
  "url": "https://example.com/webhooks/ordinal",
  "topics": [
    "post.published",
    "post.archived"
  ],
  "createdAt": "2026-01-15T10:00:00.000Z"
}

{
  "code": "BAD_REQUEST",
  "message": "Bad Request",
  "data": {
    "errors": {
      "publishAt": [
        "Invalid date format"
      ],
      "status": [
        "Invalid enum value"
      ]
    }
  }
}

{
  "code": "UNAUTHORIZED",
  "message": "Invalid or unauthorized API key"
}