Endpoint URL: {identityDomain} /{customerId} /webhooks/subscriptions/{subscriptionId}
Description
Deletes the specified webhook subscription. After a subscription has been deleted organizations no longer receive notifications for the event types associated with the subscription. In addition, any events still in the event store that are associated with the subscription are deleted.
Note that the Webhooks v3 APIs all have an API response timeout of 10 seconds.
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:
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.
URL path parameters
Parameter | Type | Required | Description |
|---|---|---|---|
{customerId} | UUID | Yes | Unique identifier of the organization (customer) associated with the webhooks subscription being deleted. For example: 9bc867ed-1f10-420f-8d90-398fde4e4779 |
{subscriptionId} | UUID | Yes | Unique identifier of the webhooks subscription being deleted. For example: 454fe969-1909-4e93-b552-674d47eafdb0 |
Request Parameters
No request parameters are required in order to call this endpoint.
Sample Request (curl)
The following command deletes the webhook subscription with the ID 454fe969-1909-4e93-b552-674d47eafdb0:
curl -X DELETE \
https://v1.api.us.janrain.com/9bc867ed-1f10-420f-8d90-398fde4e4779/webhooks/subscriptions/454fe969-1909-4e93-b552-674d47eafdb0 \
-H 'Authorization: Bearer Xk7EzdpGq5GPQcsxCWM2SxdlwU_iTsA4i2Px4TEzBrfLIvddjnDVBJxjPDuCARHH' \
-H 'Content-Type: application/json'
Responses
204 No Content
If your call to this endpoint succeeds, you won’t get back a full API response. Instead, you'll get back a 204 No Content status code.
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 and/or the specific webhooks subscription could not be found. |