getWebhookConnections

1
/{orgId}/{itemId}/webhookConnections

Gets all webhook connections from Workflow Manager.

The following information is returned with each webhook connection object:

• connectionId: The webhook connection ID.
• connectionName: The webhook connection name.
• enabled: If true, Workflow Manager will process incoming webhooks. If false, Workflow Manager will not process incoming webhooks.
• itemId: The service item ID for the webhook.
• username: The username of the user designated to perform the actions triggered by a webhook, if one is designated.
• fallbackUsername: The username of the alternate user designated to perform the actions triggered by a webhook, if one is designated.

Query parameters

Path parameters

Response status

Response details

Status Code 200

GetWebhookConnectionsResponse

Examples

Request

1
2
3
# You can also use wget
curl -X GET '/{orgId}/{itemId}/webhookConnections' \
  -H 'Authorization: Bearer <YOUR_TOKEN>'

1
2
3
4
5
6
7
8
9
10
11
12
const headers = {
  "Authorization": "Bearer <YOUR_TOKEN>"
};

fetch("/{orgId}/{itemId}/webhookConnections", {
  method: "GET",
  headers: headers
}).then(response => {
  return response.json();
}).then(body => {
  console.log(body);
});

Response

1
2
3
4
5
6
7
8
9
10
11
12
{
  "webhookConnections": [
    {
      "connectionId": "string",
      "connectionName": "string",
      "enabled": true,
      "itemId": "string",
      "username": "string",
      "fallbackUsername": "string"
    }
  ]
}