Webhook retrigger description

Use this API to manually re-trigger delivery of a webhook.

Please refer to the detailed API endpoint specification: Webhook retrigger

Purpose

This webhook allows you to manually re-trigger delivery of a webhook that has entered the Inactive state after exhausting all retry attempts.

About the Inactive state

A webhook enters the Inactive state after it fails delivery five times in a 24-hour window. Failures are triggered by timeouts or non-2xx HTTP responses. Once in this state, the webhook is no longer retried by the system and must be manually re-triggered.

Prerequisites

Making requests

Authentication

The webhooks API requires the Base URL and the contact center API key.

Endpoint

POST /api/webhooks/v1/failures/{id}/retrigger

Replace {id} with the UUID of the failed webhook event you wish to re-trigger.

Request parameters

The webhooks API uses the contact center API key in the Authorization: Bearer token in the header.

{
  "method": "POST",
  "url": "https://cluster1.voiso.com/api/webhooks/v1/failures/aabbccddeeff/retrigger",
  "headers": {
    "Authorization": "Bearer your_api_key",
    "Content-Type": "application/json"
  }
}

Path Parameters

ParameterDescriptionTypeRequiredNotes
idThe UUID of the failed webhook eventstringYesMust be in the Inactive state

Response

The following table describes the response structure:

ElementDescriptionType
statusThe result of the re-trigger requeststring
failure_idThe UUID of the webhook that was re-triggeredstring

Response sample

{
  "status": "success",
  "failure_id": "aabbccddeeff"
}

Troubleshooting

Webhook not found or not in Inactive state

If you see this error, "error": "No failed webhook found with ID {UUID}", check that the ID is correct and corresponds to a failed webhook event.

Invalid or missing API key

If you see this error, "error": "Invalid API key", ensure the contact center API key is passed in the Authorization header. See Authentication.

General API errors

For throttling, permission, or structural issues, confirm that the request complies with the Voiso API framework. Refer to Authentication.