Skip to navigation
HINDSITE APIwebhooks

List webhooks

View as Markdown

Returns every webhook in the authenticated admin’s organisation, whether it was created in Settings › Webhooks or through this API, with its signing secret.

Authentication

AuthorizationBearer

OAuth 2.0 Client Credentials Flow. To obtain an access token:

  1. Request API credentials from HINDSITE support to receive your client_id and client_secret

  2. Make a POST request to obtain an access token:

POST https://app.hindsiteind.com/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET
  1. The response will contain your access token:
{
  "access_token": "your_access_token_here",
  "token_type": "Bearer",
  "expires_in": 7200,
  "created_at": 1234567890
}
  1. Include the token in subsequent API requests:
Authorization: Bearer your_access_token_here

Response

The organisation's webhooks
idstringOptional
namestringOptional

Label shown in Settings › Webhooks.

urlstringOptionalformat: "uri"
Where event payloads are POSTed. Must be http or https and resolve to a public address.
activebooleanOptional

Inactive webhooks receive no deliveries. A webhook is deactivated automatically after sustained delivery failures and can be reactivated in Settings › Webhooks.

subscribed_actionslist of stringsOptional

Event names this webhook receives, from List subscribable events.

signing_secretstringOptional

HMAC-SHA256 key for the X-Webhook-Signature header on every delivery.

created_atdatetimeOptional
updated_atdatetimeOptional

Errors

402
Payment Required Error
403
Forbidden Error