API
Start typing to search…

List Webhooks v3 subscriptions

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

Returns your Webhooks v3 subscriptions. Subscriptions define the events that result in webhook notifications being sent to your listener endpoint.

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.

Query Params
integer

Page number of the response the operation returns. Webhooks v3 paginates responses to minimize bandwidth and speed up response time. When viewing a larger response, the links shows the next page number. Call the operation again, setting this parameter's value to the one in the links. If you set an invalid page number, the operation returns the last page of your results set. If you leave out this parameter, the operation returns all the pages in the results set.

Responses

Response body
object
_embedded
object

Properties and property values for your webhook subscriptions.

subscriptions
array of objects
required
length ≥ 0

Information about your webhook subscriptions. This value is empty if you don't have any subscriptions.

subscriptions*
object
_links
object
required

Navigable hypermedia links for the webhooks subscription.

date-time
required

Timestamp indicating the subscription's creation date.

string
required
length ≥ 1

Unique identifier Akamai issues to you when you subscribe to Identity Cloud. To verify your Akamai customer ID, log into Console and, on the Manage Application page, check the value of the customer_id application setting.

boolean
required

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. In addition, Webhooks v3 marks these events 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*
string
required
length ≥ 1

Unique identifier of a Webhooks v3 subscription.

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.

date-time
required

Timestamp indicating the subscription's last update time.

_links
object

Navigable hypermedia links for your Webhook subscriptions.

self
object
required

Navigable hypermedia link for your Webhook subscriptions.

integer
required
≥ 0

Total number of Webhooks v3 subscriptions available to you.

Updated about 1 year ago

Did this page help you?
Language
Credentials
URL

Updated about 1 year ago

Did this page help you?