Redeliver Webhook Event

Description

Redeliver a specified webhook event to a subscription endpoint URL. This can be useful to replay a missed event and for testing.

The endpoint triggers an event delivery and returns a webhook event object.

Endpoint

Staging

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

Production

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

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

POST

Request Syntax

POST /hooks/<hook-id>/requests/<request_id>/redeliver

Request Parameters

URL Parameters

  • hook-id
    • A unique ID for this subscription within your tenant.
    • Type: UUID (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
    • Required: Yes
  • request-id
    • Unique ID for this event request.
    • 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": true,
  "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
    • Will always be true for a redelivered 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 (verify bearer token from authentication)
  • 404 Not found (verify hook id and request id are valid)
  • 500: Internal server error

Examples

Example Request

curl --request POST \
  --url https://hookshot.boldpenguin.com/hooks/e6db9c1a-d15f-4248-81fa-5b61fc321def/requests/29dd8606-4e01-46cb-aca2-dd6022e74865/redeliver \
  --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": true,
  "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
}
← Receive ProspectSend Application Form →