Webhooks

Register a webhook endpoint

Registers a URL that receives ALL events (post.published, post.partially_failed, post.failed, post.scheduled, account.unauthorized, image.completed, image.failed). Deliveries are HTTP POSTs with a WebhookEventPayload body, retried up to 5 times with exponential backoff. Each request includes x-adaptly-signature, x-adaptly-timestamp, x-adaptly-event, and x-adaptly-webhook-id headers. Webhooks are auto-disabled after 20 consecutive failed deliveries.. Requires the webhooks.manage permission.

post/webhooks

Request

  • Base URL: https://post.adaptlypost.com/post/api/v1
  • URL: https://post.adaptlypost.com/post/api/v1/webhooks
  • Auth: HTTP bearer

Headers

X-Workspace-Idstring

The workspace to act in, for OAuth sign-ins that reach several workspaces. Take the id from GET /workspaces. Without it the call lands in the default workspace. A workspace the caller cannot reach answers 403 with code: workspace_access_denied. An API key belongs to one workspace: send its own id or leave the header out

Request body

urlstring uri required

Publicly reachable http(s) endpoint. Receives all events

Response

Created webhook (the only response that includes the signing secret)

idstring
urlstring
activeboolean
createdAtstring date-time
updatedAtstring date-time
lastSuccessAtstring date-time nullable
lastFailureAtstring date-time nullable
disabledAtstring date-time nullable
secretstring

HMAC-SHA256 signing secret (whsec_...) for the x-adaptly-signature header. Returned ONLY at creation, store it securely; if lost, delete and re-create the webhook

Changes

No recorded changes to this operation across all 2 revisions of this API.