Webhooks

Update webhook subscription

patch/api/v1/webhooks/{id}

Request

  • Base URL: https://www.poster.ly
  • URL: https://www.poster.ly/api/v1/webhooks/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Webhook ID

Request body

urlstring uri
descriptionstring nullable
eventsstring[]
workspace_idstring nullable
is_activeboolean

Example request

{
  "url": "https://example.com/posterly-webhooks",
  "events": [
    "post.created",
    "post.published",
    "post.failed"
  ]
}

Response

Webhook updated successfully

secretstring nullable

Example response

{
  "webhook": {
    "id": "f7c590f8-a997-4b6c-8a8a-13b4e93ec8af",
    "url": "https://example.com/posterly-webhooks",
    "events": [
      "post.created"
    ],
    "is_active": true
  },
  "secret": "whsec_123"
}

Changes

No recorded changes to this operation across all 1 revision of this API.