younifyd
Menu

Get Webhooks

List webhooks

GET/v1/webhooks

Use it in a workflow

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

Request

Query parameters

applicationIdsstring

Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

The number of items to skip when paging through large result sets.

creationTypestring

Filter results by creation type.

One oftemplateWebhookswebhooks

visibilitystring

Filter results by visibility.

One ofvisiblehidden

outgoingIntegrationsTypeIdinteger (int64)

Filter results by outgoing integration type ID.

titlestring

Filter results performing case-insensitive matching against the webhook title.

Response

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

totalResultSizeinteger (int64)
dataarray<object>
idinteger (int64)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.

applicationIdsarray<integer (int64)>required

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

titlestringrequired

Name or title for this webhook.

descriptionstring

A description of the webhook.

draftbooleanrequired

Indicates if the webhook is a draft.

verbstringrequired

API method for this webhook.

One ofPOSTPUTGETDELETEPATCH

urlstringrequired

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

headersarray<string>required

List of API HTTP headers for this webhook.

payloadstring

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

paramsarray<object>required7 fields

Array of template argument definitions.

enabledbooleanrequired

Enables or disables webhook from showing in the Rule Builder.

authenticationIdinteger (int64)

The ID of the credential that this webhook is using.

outgoingIntegrationTemplateIdinteger (int64)

Identifier of the outgoing integration template.

outgoingIntegrationTypeIdinteger (int64)

Identifier of the outgoing integration type.

outgoingIntegrationTypeNamestring

Name of the outgoing integration.

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

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