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

Enables you to schedule delivery for a specific event that failed its previous delivery attempts.

This endpoint supports the following methods:

  • POST

POST

Description

Schedules the specified webhooks event for redelivery to your listener endpoint. Note that you can only redeliver events that have been marked as failure. Events in other states (successexecutingawaiting-executing, or retry) have either already been scheduled for redelivery or are in the process of being delivered.

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 whose event is being redelivered. For example:

9bc867ed-1f10-420f-8d90-398fde4e4779

{subscriptionId}

UUID

Yes

Unique identifier of the webhooks subscription associated with the event being redelivered. For example:

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

{eventId}

UUID

Yes

Unique identifier of the webhooks event being redelivered. 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 /{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 the event notification with the event ID d375d2f8-e2d8-4859-9c31-648468b80acdv for redelivery:


curl -X POST \
  https://v1.api.us.janrain.com/9bc867ed-1f10-420f-8d90-398fde4e4779/webhooks/subscriptions/454fe969-1909-4e93-b552-674d47eafdb0/events/d375d2f8-e2d8-4859-9c31-648468b80acd/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.