Modify a subscription

patch

https://{hostname}/{customerId}/webhooks/subscriptions/{subscriptionId}

Modifies a Webhooks v3 subscription. Use this method to modify selected properties of a subscription. Updates are made only to the items in the request body. Any items not in the request are left as they are. Note that Webhooks v3 doesn't support the PUT method. You need to use PATCH when modifying a subscription. When using the PATCH method, set your Content-Type header to application/merge-patch+json.

Path Params

customerId

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.

subscriptionId

string

required

Unique identifier of a Webhooks v3 subscription. Use the List subscriptions operation to return the IDs of your subscriptions.

Body Params

enabled

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. In addition, Webhooks v3 marks these events as failure events.

endpoint

string

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

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

title

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.

Headers

Content-Type

string

enum

required

Enum Method to use when updating a webhooks subscription. Set the value to application/merge-patch+json to modify individual properties and property values in the subscription. For example, if you're only updating the enabled property that means that enabled is the only property you need in your request body.

Set this to application/json-patch+json to replace the subscription's data with what's in your request. In this case, all the subscription data needs to be in the request body. If you don't include all required members, the operation fails. Any optional data member you leave out gets set to null. Note that, regardless of which method you use, the content type in the response is always application/json.

Allowed:

Responses

200Webhook subscription modifications successful.

403You don't have permission to access the resource.

404A path component couldn’t be found.