Social API reference

Social API · Webhooks

patch/v1/communities/{community_id}/webhooks/{webhook_id}Auth

Update webhook url, subscribed event types, or disabled state. `{ "disabled": false }` is the re-enable path after an auto-disable — no secret rotation required.

Deprecated: use `/v1/communities/{community_id}/webhooks/endpoints` (or `/v1/workspaces/{workspace_id}/webhooks/endpoints` for one endpoint that receives every community's events): Standard Webhooks signing, event descriptions, Send test that reports the result, an event log, replay and rotation with a grace period. Responses carry `Deprecation: true` and `Sunset: Fri, 15 Jan 2027 00:00:00 GMT`.

Path parameters

community_id*string

Social community UUID.

webhook_id*string

Webhook UUID.

Request body

urlstring

New subscriber URL.

event_typesarray

New subscription set. Unknown values are rejected with a 400 naming the valid set.

disabledboolean

Set `false` to re-enable a disabled webhook (clears the auto-disable state and resets the failure streak — no secret rotation required). Set `true` to disable it manually.

Example: false

Response · 200 Webhook updated.

id*string · uuid

Webhook UUID.

Example: "dddddddd-0000-0000-0000-000000000001"

community_id*string · uuid

Owning community UUID.

Example: "cccccccc-cccc-cccc-cccc-cccccccccccc"

url*string

Subscriber URL.

Example: "https://example.com/webhooks/social"

event_types*array

Subscribed event types. Each item is one of the social event names — see GET /v1/webhook-event-types for the live catalog.

Example: ["post.created","comment.created"]

signing_secret_hint*string

Last 4 chars of the signing secret. Use the full secret returned by create / rotate to verify the Standard Webhooks `webhook-signature` header (or, until the sunset, the X-Pcft-Signature header).

Example: "abcd"

disabled_at*string · date-time

ISO timestamp when the webhook was auto-disabled (or null if active).

Example: null

disabled_reason*string

Why the webhook is off: `manual` (switched off) or `failing` (switched off automatically after 20 failures in a row or 24 h of failures). Null while it is on.

Example: null

consecutive_failures*number

Consecutive failed attempts since the last success.

Example: 0

last_success_at*string · date-time

ISO timestamp of the most recent 2xx response.

Example: null

last_failure_at*string · date-time

ISO timestamp of the most recent non-2xx response.

Example: null

created_at*string · date-time

ISO timestamp.

Example: "2026-05-01T12:00:00.000Z"

updated_at*string · date-time

ISO timestamp.

Example: "2026-05-01T12:00:00.000Z"

Example

Request

PATCH https://social.productcraft.co/v1/communities/{community_id}/webhooks/{webhook_id}
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "url": "string",
  "event_types": [
    "post.created"
  ],
  "disabled": false
}

Response

{
  "id": "dddddddd-0000-0000-0000-000000000001",
  "community_id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
  "url": "https://example.com/webhooks/social",
  "event_types": [
    "post.created",
    "comment.created"
  ],
  "signing_secret_hint": "abcd",
  "disabled_at": null,
  "disabled_reason": null,
  "consecutive_failures": 0,
  "last_success_at": null,
  "last_failure_at": null,
  "created_at": "2026-05-01T12:00:00.000Z",
  "updated_at": "2026-05-01T12:00:00.000Z"
}