Skip to main content

List Webhook Subscriptions

Description​

List all webhook subscriptions within your Bold Penguin tenant.

The endpoint returns a list of webhook subscription objects.

Endpoint​

Staging​

https://hookshot-uat.beta.boldpenguin.com/hooks

Production​

https://hookshot.boldpenguin.com/hooks

Authentication​

This endpoint requires an access_token from the authentication endpoint in the same environment with the appropriate permissions. Include it as a bearer token in an Authorization header for the request.

Authorization: Bearer <access_token>

Methods​

GET

Request Syntax​

GET /hooks

Response Syntax​

[
  {
    "id": "<UUID>",
    "active": <boolean>,
    "confirmed": false,
    "events": [
      "<string>",
      "<string>",
      ...
    ],
    "config": {
      "url": "<string>",
      "secret": "<string>",
      "header": "<string>"
    },
    "owner_id": "<UUID>",
    "tenant_id": "<UUID>",
    "created_at": "<Timestamp>",
    "updated_at": "<Timestamp>"
  },
  {
    "id": "<UUID>",
    "active": <boolean>,
    "confirmed": false,
    "events": [
      "<string>",
      "<string>",
      ...
    ],
    "config": {
      "url": "<string>",
      "secret": "<string>",
      "header": "<string>"
    },
    "owner_id": "<UUID>",
    "tenant_id": "<UUID>",
    "created_at": "<Timestamp>",
    "updated_at": "<Timestamp>"
  },
  ...
]

Response Elements​

Each webhook subscription object in the array will contain the following elements:

  • id
    • A globally unique ID for this subscriptions within your tenant.
    • Type: UUID
  • active
    • Is this subscriptions currently receiving events
    • Type: Boolean
  • confirmed
    • Unused (always false)
    • Type: Boolean
  • events
    • An array of valid subject or subject:action strings (see Event Subjects & Payloads for allowed values)
    • Or a wildcard ("*")
    • Type: Array of strings
  • config
    • Configuration object containing url, secret, and header
    • Type: Configuration object
    • Object elements:
      • url
        • A valid URL string to receive events
        • Type: URL string
        • Required: Yes
      • header
        • Static HTTP header for authentication or other purposes.
        • Type: String (format Name: Value)
        • Required: No
      • secret

Status Codes​

  • 200: Success
  • 401 Unauthorized: The necessary authentication credentials are not present in the request or are incorrect.## Examples

Example Request​

curl --request GET \
  --url https://hookshot.boldpenguin.com/hooks \
  --header 'authorization: Bearer <access-token>' \
  --header 'content-type: application/json' \

Example Responses​

[
  {
    "id": "e6db9c1a-d15f-4248-81fa-5b61fc321def",
    "active": true,
    "confirmed": false,
    "events": [
      "*"
    ],
    "config": {
      "url": "https://chuck-webhook.ngrok.io",
      "secret": "",
      "header": "User: Chuck"
    },
    "owner_id": "46912066-9be9-4a04-97ea-5505a1acde",
    "tenant_id": "94f43d40-a61c-4d4d-918e-d888aabe906a",
    "created_at": "2020-09-24T13:47:16.856Z",
    "updated_at": "2020-09-24T13:47:16.856Z"
  },
  {
    "id": "a2f47f57-dbd3-4951-ad93-5d31aa20fb81",
    "active": true,
    "confirmed": false,
    "events": [
      "application_form:finished_quoting"
    ],
    "config": {
      "url": "https://12345.execute-api.us-east-2.amazonaws.com/",
      "secret": "",
      "header": "User: Chuck"
    },
    "owner_id": "46912066-9be9-4a04-97ea-5505a1acde",
    "tenant_id": "94f43d40-a61c-4d4d-918e-d888aabe906a",
    "created_at": "2020-09-24T13:47:16.856Z",
    "updated_at": "2020-09-24T13:47:16.856Z"
  }
]