Webhooks

Add a webhook

Add a webhook subscription to the account

post/v1/workspaces/{workspace_id}/webhooks

Request

  • Base URL: https://api.oxvo.com
  • URL: https://api.oxvo.com/v1/workspaces/{workspace_id}/webhooks
  • Auth: API key in header api_access_token

Path parameters

workspace_idinteger required

The numeric ID of the workspace

Request body

urlstring

The url where the events should be sent

namestring

The name of the webhook

subscriptionsstring[]

The events you want to subscribe to.

Example request

{
  "url": "https://example.com/webhook",
  "subscriptions": [
    "conversation_created",
    "conversation_status_changed"
  ]
}

Response

Success

idnumber

The ID of the webhook

urlstring

The url to which the events will be send

namestring

The name of the webhook

subscriptionsstring[]

The list of subscribed events

account_idnumber

The id of the account which the webhook object belongs to

Changes

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