/{customerId}/webhooks/subscriptions/{subscriptionId}/events/redeliver

Enables you to schedule redelivery for events that failed previous delivery attempts.

This endpoint supports the following methods:

  • POST

POST

Description

Redelivers all the failed events in the event store. When an event occurs, Webhooks v3 makes up to six attempts over the span of 24 hours to deliver that event to your listener endpoint. After the sixth such try, the event is marked as failure and no further deliveries are attempted. The event itself remains in the event store for 7 days before being deleted.

Before those 7 days have expired, however, you can use the /redeliver endpoint to schedule redelivery of all the failed events. When you do this, two things happen:

  1. The event status for each failed event is changed to awaiting-executing. Event dispatchers are then free to claim the event and attempt to deliver it.
     
  2. The event delivery “clock” is reset. That means that the event is treated as if it was a brand-new event, and Webhooks v3 will make as many as six attempts over the next 24 hours to deliver the event. If the event still can’t be delivered, it will be marked as failure and then remain in the event store for 7 days. If you call the /redeliver endpoint Webhooks v3 will try again to deliver the event.

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:

https://v1.api.us.janrain.com

If you are in the Australian (AU) region your base URL will look like this:

https://v1.api.au.janrain.com 

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 whose events are being redelivered. For example:

454fe969-1909-4e93-b552-674d47eafdb0

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 configuration client (using the client ID as the username and the client secret as the password) to access the /{customer_id}}/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:

-H 'Authorization: Bearer 03v-eeodppPrrHXXIx56pRLyDBaOldDxqEwI59MFCFGVuSkLRapzgmfwmEHyKWle'

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 all the event notifications associated with the webhooks subscription 454fe969-1909-4e93-b552-674d47eafdb0 for redelivery:

curl -X POST \
  https://v1.api.us.janrain.com/9bc867ed-1f10-420f-8d90-398fde4e4779/webhooks/subscriptions/454fe969-1909-4e93-b552-674d47eafdb0/events/redeliver \
  -H 'Authorization: Bearer Xk7EzdpGq5GPQcsxCWM2SxdlwU_iTsA4i2Px4TEzBrfLIvddjnDVBJxjPDuCARHH'

Responses

202 Accepted

If your call to this endpoint succeeds, you'll get back a 202 Accepted status code and a message similar to the following:

{
  Redelivery has been scheduled.
}

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

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.