Webhooks

List Webhooks

List the webhooks configured for the team, with their signing secrets.

GET
/api/v1/webhooks

List the webhooks configured for the team, with their signing secrets. Use it to check what is subscribed before adding another endpoint.

Authorization

AuthorizationBasic <token>

Basic API key authentication. Create a new API key and secret in the Recommand dashboard.

In: header

Query Parameters

companyId?|

Return the webhooks that deliver this company's events: the ones limited to it, plus the team-wide webhooks that receive every company's events. Leave it out to list all of the team's webhooks.

Example"c_01JQZ8X0M4T7RB6K9V2NDHW3PA"

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/webhooks"
{  "success": true,  "webhooks": [    {      "id": "wh_01JQZ8X0M4T7RB6K9V2NDHW3PA",      "teamId": "team_01JQZ8X0M4T7RB6K9V2NDHW3PA",      "companyId": null,      "url": "https://example.com/hooks/recommand",      "secret": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}