Endpoint URL: {identityDomain} /{customerId} /webhooks/subscriptions/{subscriptionId}/events/{eventId}/redeliver
Description
Schedules the specified event for redelivery to your listener endpoint. Note that you can only redeliver events that have been marked as failure: your API call fails if you try to redeliver an event in in any other state (success, executing, awaiting-executing, or retry). In addition, keep in mind that you can only retrieve one failed event at a time: currently there is no way to, say, retrieve all the failed events in a single operation. If you have 7 failed events you'd like to retrieve you'll need to make 7 separate API calls, one for each event.
Be sure to use the POST method when making your API call.
Respects the API Client Allow List: No
Base URL
The base URL for this endpoint is your Identity Cloud API URL, including the appropriate region. For example, if you are in the US region, then your base URL will look like this:
If you are in the Australian (AU) region your base URL will look like this:
URL path parameters
Parameter | Type | Required | Description |
|---|---|---|---|
{customerId} | UUID | Yes | Unique identifier of the organization (customer) associated with the webhooks subscription. For example: 9bc867ed-1f10-420f-8d90-398fde4e4779 |
{subscriptionId} | UUID | Yes | Unique identifier of the webhooks subscription associated with the event being scheduled for redelivery. For example: 454fe969-1909-4e93-b552-674d47eafdb0 |
{eventId} | UUID | Yes | Unique identifier of the webhooks event being scheduled for redelivery. For example: d375d2f8-e2d8-4859-9c31-648468b80acd |
Request Parameters
No additional parameters are required in order to call this endpoint.
Authentication
This endpoint requires token-based authentication. To obtain an access token, you must use a confidential client (using the client ID as the username and the client secret as the password) to access the /{customerId}/login/token endpoint. The access token returned from that endpoint is then used in the Authorization header of your API call. For example, if you get back the access token 03v-eeodppPrrHXXIx56pRLyDBaOldDxqEwI59MFCFGVuSkLRapzgmfwmEHyKWle then your Authorization header will look like this when using Curl:
In Postman, set the Authorization Type to Bearer and use the access token as the value of the Token field.
Sample Request (curl)
The following command schedules the event a2635854-4b1a-4eb7-a9ad-7e554946d439 for redelivery:
curl -X POST \
https://v1.api.us.janrain.com/9bc867ed-1f10-420f-8d90-398fde4e4779/webhooks/subscriptions/454fe969-1909-4e93-b552-674d47eafdb0/events/a2635854-4b1a-4eb7-a9ad-7e554946d439/redeliver
-H 'Authorization: Bearer Xk7EzdpGq5GPQcsxCWM2SxdlwU_iTsA4i2Px4TEzBrfLIvddjnDVBJxjPDuCARHH'
Responses
202 Accepted
If your call to this endpoint succeeds, you'll get back the HTTP status code 202 Accepted.
Error Response Codes
The following table includes information about some of the other response codes that you might encounter when calling this endpoint.
Response Code | Description |
400 | Bad request. Typically occurs if your API call includes a body parameter of any type. You cannot use body parameters when calling the /redeliver endpoint. |
403 | Forbidden. You do not have permission to access the requested resource. You will often see this error if you are using an expired access token. By default, access tokens can only be used for one hour before they need to be replaced. |
404 | Not found. The specified customer, the specified event, and/or the specific webhooks subscription could not be found. |
409 | Conflict. Typically occurs in one of two instances: 1) the event being rescheduled has not been marked as failed; or, 2) the referenced Webhooks subscription is currently disabled. |
429 | Too many requests. Occurs if you exceed the rate limit imposed on the /redeliver endpoint. |