Webhooks

Create a webhook

Create a new webhook endpoint. Maximum 10 webhooks per user. The webhook secret is only returned on creation - save it securely.

post/webhooks

Request

  • Base URL
    https://api.publora.com/api/v1
  • Auth
    API key in header x-publora-key

Request body

namestring required

Friendly name for the webhook

urlstring uri required

HTTPS URL to receive webhook events

eventsstring[] required

Events to subscribe to. token.expiring is defined but not currently dispatched; post.demoted fires when a scheduled group is returned to draft: reason media_changed (changeType attach, detach, prune_reference or reorder), media_backstop (changeType scheduler_media_backstop) or state_mismatch (changeType scheduler_state_repair). Tolerate unknown changeType and reason values.

Example request

{
  "name": "Production webhook",
  "url": "https://example.com/webhooks/publora",
  "events": [
    "post.published",
    "post.failed"
  ]
}

Response

Webhook created

successboolean

Example response

{
  "success": true
}

Changes

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