Get Webhook

Get webhook

GET/v1/webhooks/{webhookId}

Use it in a workflow

Add a step and choose the Talon.One connector.
Pick the Get Webhook action (under management).
Fill in the fields below, then reference the result from later steps as {{getWebhook.response.data}}.

Request

Path parameters

webhookIdinteger (int64)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

Returns 200 with an object. Read it in later steps with {{getWebhook.response.data.<field>}}.

idinteger (int64)

The internal ID of this entity.

createdstring (date-time)

The time this entity was created.

modifiedstring (date-time)

The time this entity was last modified.

applicationIdsarray<integer (int64)>

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

titlestring

Name or title for this webhook.

descriptionstring

A description of the webhook.

draftboolean

Indicates if the webhook is a draft.

verbstring

API method for this webhook.

One ofPOSTPUTGETDELETEPATCH

urlstring

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

headersarray<string>

List of API HTTP headers for this webhook.

payloadstring

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

paramsarray<object>

Array of template argument definitions.

typestringrequired

The type of value this argument expects.

One ofstringbooleannumbertime(list string)(list number)

descriptionstring

A campaigner-friendly description of the argument, this will also be shown in the rule editor.

titlestringrequired

A campaigner friendly name for the argument, this will be shown in the rule editor.

uiobjectrequired

Arbitrary metadata that may be used to render an input for this argument.

keystring

The identifier for the associated value within the JSON object.

picklistIDinteger (int64)

ID of the picklist linked to a template.

restrictedByPicklistboolean

Whether or not this attribute's value is restricted by picklist (`picklist` property)

enabledboolean

Enables or disables webhook from showing in the Rule Builder.

authenticationIdinteger (int64)

The ID of the credential that this webhook is using.

json

{
  "id": 6,
  "created": {},
  "modified": {},
  "applicationIds": [
    0
  ],
  "title": "Send message",
  "draft": false,
  "verb": "POST",
  "url": "www.my-company.com/my-endpoint-name",
  "headers": [
    "{\"Authorization\": \"Basic bmF2ZWVua3VtYXIU=\"}",
    "{\"Content-Type\": \"application/json\"}"
  ],
  "params": [],
  "enabled": true,
  "description": "A webhook to send a coupon to the user."
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Was this page helpful?