COcontentsnare
Webhooks

Create webhook

Creates a new webhook<br>Required scopes: <b>administration</b>

post/partner_api/v1/webhooks

Request

  • Base URL
    https://api.contentsnare.com
  • Auth
    • OAuth 2
      Authorization code: /oauth/authorization
      Token URL: /oauth/token scopes: administration
    • or HTTP bearer

Request body

enabledboolean

Specifies if webhook is enabled

subscriptionsstring[]

List of events associated with webhook

urlstring required

Your webhook URL

Example request

{
  "enabled": true,
  "subscriptions": [
    "client_created",
    "client_updated",
    "client_destroyed"
  ],
  "url": "https://example.com/handle_webhook"
}

Response

successful

enabledboolean
idstring
subscriptionsstring[]
typestring
urlstring

Example response

{
  "enabled": true,
  "id": "whk_ObYa4GYbUdoN9X",
  "subscriptions": [
    "client_created",
    "client_updated",
    "client_destroyed"
  ],
  "type": "api (or ui)",
  "url": "https://example.com/handle_webhook"
}

Changes

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