TAtalon
Webhooks

Get webhook

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Returns a webhook by its id.

get/v1/webhooks/{webhookId}

Request

Path parameters

webhookIdinteger required

The ID of the webhook. You can find the ID in the Campaign Manager's URL when you display the details of the webhook in Account > Webhooks.

Response

OK

idinteger required

The internal ID of this entity.

createdstring date-time required

The time this entity was created.

modifiedstring date-time required

The time this entity was last modified.

applicationIdsinteger[] required

The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in All Applications.

titlestring required

Name or title for this webhook.

descriptionstring

A description of the webhook.

draftboolean required

Indicates if the webhook is a draft.

verb'POST' | 'PUT' | 'GET' | 'DELETE' | 'PATCH' required

API method for this webhook.

urlstring required

API URL (supports templating using parameters) for this webhook.

headersstring[] required

List of API HTTP headers for this webhook.

payloadstring

API payload (supports templating using parameters) for this webhook.

enabledboolean required

Enables or disables webhook from showing in the Rule Builder.

authenticationIdinteger

The ID of the credential that this webhook is using.

Example response

{
  "id": 6,
  "created": "2020-06-10T09:05:27.993483Z",
  "modified": "2021-09-12T10:12:42Z",
  "title": "Send message",
  "description": "A webhook to send a coupon to the user.",
  "verb": "POST",
  "url": "www.my-company.com/my-endpoint-name",
  "headers": [
    "{\"Authorization\": \"Basic bmF2ZWVua3VtYXIU=\"}",
    "{\"Content-Type\": \"application/json\"}"
  ],
  "payload": "{\n\t\"message\": \"${message}\"\n}",
  "params": [],
  "enabled": true,
  "authenticationId": 1
}

Changes

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