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}

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

idstring<uuid>required

The unique identifier of the webhook to update

Request body

application/json

namestring

The name of the webhook

min length 1

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

min items 1

headersobject

Optional custom headers to include in webhook requests

Responses

200

Webhook updated

idstring<uuid>

namestring

urlstring<uri>

descriptionstring | null

headersobject | null

topicsstring[]

createdAtstring<date-time>

createdByWebhookCreatedBy

User who created the webhook

Show properties

idstring<uuid>

emailstring<email>

firstNamestring | null

lastNamestring | null

400

Bad Request - Invalid input parameters

codestring

messagestring

dataobject

Show properties

errorsobject

401

Unauthorized - Missing or invalid API key

codestring

messagestring

404

Not Found - Resource does not exist

codestring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

idpath*The unique identifier of the webhook to update

Bodyapplication/json

Request body

Request

curl -X PATCH 'https://app.tryordinal.com/api/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "CRM Sync (Updated)",
  "url": "https://example.com/webhooks/ordinal-v2",
  "topics": [
    "post.published",
    "post.archived",
    "post.content.edited"
  ]
}'

const response = await fetch("https://app.tryordinal.com/api/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"CRM Sync (Updated)\",\n  \"url\": \"https://example.com/webhooks/ordinal-v2\",\n  \"topics\": [\n    \"post.published\",\n    \"post.archived\",\n    \"post.content.edited\"\n  ]\n}"
});

import requests

response = requests.patch(
    "https://app.tryordinal.com/api/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"CRM Sync (Updated)\",\n  \"url\": \"https://example.com/webhooks/ordinal-v2\",\n  \"topics\": [\n    \"post.published\",\n    \"post.archived\",\n    \"post.content.edited\"\n  ]\n}",
)

Response

{
  "id": "550e8400-e29b-41d4-a716-446655440900",
  "name": "CRM Sync (Updated)",
  "url": "https://example.com/webhooks/ordinal-v2",
  "description": "Sync published posts to our CRM",
  "headers": {
    "X-Custom-Header": "value"
  },
  "topics": [
    "post.published",
    "post.archived",
    "post.content.edited"
  ],
  "createdAt": "2026-01-15T10:00:00.000Z",
  "createdBy": {
    "id": "550e8400-e29b-41d4-a716-446655440010",
    "email": "john@acme.com",
    "firstName": "John",
    "lastName": "Doe"
  }
}

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

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

{
  "code": "NOT_FOUND",
  "message": "Post not found or does not belong to this workspace"
}