API

Create a subscription

post
https://{hostname}//webhooks/subscriptions

Creates a Webhooks v3 subscription.

Path Params
string
required

Unique identifier of an Akamai customer. To verify your customer ID, log in to Console and then, on the Manage Application page, check the value of the customer_id setting.

Body Params

Creates a webhooks subscription. Webhook subscriptions determine the event types that trigger near real-time notifications.

boolean
Defaults to true

Indicates the status of a webhooks subscription. If you disable a subscription, Webhooks v3 continues to monitor events, and adds any relevant event notifications to the Webhooks event store. However, these notifications aren’t sent to your listener endpoint. Webhooks v3 marks these as failure events.

string
required
length ≥ 1

URL of the Webhooks listener endpoint. You set up and maintain listener endpoints on your network to receive and process the event notifications sent by Webhooks v3. See Configure a webhook listener endpoint for information on configuring your listener endpoint URL.

events
array of strings
required
length ≥ 0

Identity Cloud events that trigger webhook event notifications. Possible values are: entityCreated, entityDeleted, and entityUpdated. An entityCreated event occurs when a user creates an account. An entityDeleted event occurs when a user deletes an account. An entityUpdated event occurs when a user modifies an account. You can also add a filter to your subscription to allow for more fine-grain notifications. See Create a webhook event filter for more information.

events*
Allowed:
string
required
length between 2 and 200

Name of the Webhooks v3 subscription. Subscription titles need to be unique for a given customer ID, and contain from 2 to 200 characters.

Responses

Updated 4 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago