Skip to main content

List Webhook Events

Description​

List the most recent webhook events for a webhook subscription. This can be useful for monitoring and troubleshooting.

The endpoint returns a list of webhook event objects.

Endpoint​

Staging​

https://hookshot-uat.beta.boldpenguin.com/hooks/<hook-id>/requests

Production​

https://hookshot.boldpenguin.com/hooks/<hook-id>/requests

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/<hook-id>/requests

Request Parameters​

URL Parameters​

  • hook-id
    • A unique ID for this subscription within your tenant.
    • Type: UUID (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
    • Required: Yes

Response Syntax​

[
  {
    "id": "<UUID>",
    "tenant_id": "<UUID>",
    "delivery_id": "<UUID>",
    "event": "<string>",
    "enqueued_at": "<Timestamp>",
    "redelivery": <boolean>,
    "hook_id": "<UUID>",
    "created_at": "<Timestamp>",
    "updated_at": "<Timestamp>",
    "response_status": <HTTP Status Code>,
    "response_duration_ms": <integer>
  },
  ...
  {
    "id": "<UUID>",
    "tenant_id": "<UUID>",
    "delivery_id": "<UUID>",
    "event": "<string>",
    "enqueued_at": "<Timestamp>",
    "redelivery": <boolean>,
    "hook_id": "<UUID>",
    "created_at": "<Timestamp>",
    "updated_at": "<Timestamp>",
    "response_status": <HTTP Status Code>,
    "response_duration_ms": <integer>
  }
]

Response Elements​

  • id
    • A globally unique ID for this event within this subscription.
    • Type: UUID
  • tenant_id
    • Unique identifier for the tenant where this event occurred.
    • Type: UUID
  • delivery_id
    • Unique identifier for this delivery attempt. There may be multiple delivery attempts for a single event dependent on response status.
    • Type: UUID
  • event
  • redelivery
    • Is this a redelivery for this event
    • Type: Boolean
  • hook_id
    • A globally unique ID for this subscription within your tenant.
    • Type: UUID
  • response_status
    • HTTP status code response from the subscription URL for this delivery attempt.
    • Type: HTTP Status Code
  • response_duration_ms
    • Time in milliseconds to receive a response from the subscription URL.
    • Type: Integer

Status Codes​

  • 200: Success
  • 401 Unauthorized: The necessary authentication credentials are not present in the request or are incorrect.
  • 404 Not found (verify hook id is valid)

Examples​

Example Request​

curl --request GET \
  --url https://hookshot.boldpenguin.com/hooks/e6db9c1a-d15f-4248-81fa-5b61fc321def/requests \
  --header 'authorization: Bearer <access-token>' \

Example Responses​

[
  {
    "id": "29dd8606-4e01-46cb-aca2-dd6022e74865",
    "tenant_id": "5323b917-54f9-4866-aec7-67a5f1062be1",
    "delivery_id": "2f2611b4-9f41-4dd2-81b2-3c74eb6a79b8",
    "event": "application_form:inactive",
    "enqueued_at": "2020-09-30T21:18:03.353Z",
    "redelivery": false,
    "hook_id": "e6db9c1a-d15f-4248-81fa-5b61fc321def",
    "created_at": "2020-09-30T21:18:03.426Z",
    "updated_at": "2020-09-30T21:18:03.426Z",
    "response_status": 200,
    "response_duration_ms": 293
  },
  {
    "id": "c20e05ab-5ceb-402f-80fe-2dae79b9033b",
    "tenant_id": "5323b917-54f9-4866-aec7-67a5f1062be1",
    "delivery_id": "24b03dd3-26a5-4139-bd6a-9b24926d5ae8",
    "event": "application_form:taken_over",
    "enqueued_at": "2020-09-30T19:30:02.001Z",
    "redelivery": false,
    "hook_id": "e6db9c1a-d15f-4248-81fa-5b61fc321def",
    "created_at": "2020-09-30T19:30:02.049Z",
    "updated_at": "2020-09-30T19:30:02.049Z",
    "response_status": 200,
    "response_duration_ms": 241
  },
  {
    "id": "1cb302c3-f525-4f9e-a8d3-904bfc9b3e98",
    "tenant_id": "5323b917-54f9-4866-aec7-67a5f1062be1",
    "delivery_id": "b847052e-dfbe-4df6-9c2a-416c6134b4e1",
    "event": "question_set:completed",
    "enqueued_at": "2020-09-30T18:51:05.886Z",
    "redelivery": false,
    "hook_id": "e6db9c1a-d15f-4248-81fa-5b61fc321def",
    "created_at": "2020-09-30T18:51:05.890Z",
    "updated_at": "2020-09-30T18:51:05.890Z",
    "response_status": 200,
    "response_duration_ms": 87
  }
]