Skip to main content
Update an existing webhook’s status, URL, shared secret, or authorisation header.

​
Update a webhook

PATCH v2/webhooks/{webhookId}?accountId={accountId}

​
Request

Use this request to update an existing webhook. Set the enabled field to true to make it available or false to make it unavailable. If you have a user-level API key, you need to specify an accountId to use this request. If you have a product-level API key, you can choose to update this across all accounts by omitting the accountId query parameter.

​
Path parameters

​
webhookId
string
required
The ID of the webhook that you want to update.Allowable values: An existing webhookId (≤ 36 characters)

​
Query parameters

​
accountId
string
The account ID to filter the response with. This is required if you have a user-level API key.Allowable values: An existing accountId (≤ 36 characters)

​
Request body schema

​
sharedSecret
string (uuid)
When provided, we use this to generate a hash-based message authentication code (HMAC) using the SHA-256 algorithm. We Base64 encode this signature. Every event notification you receive for this webhook will include an x-em-signature header, if a shared secret has been provided. You can use this to verify the integrity and authenticity of the message.Allowable values: ≤ 36 characters
​
enabled
boolean
required
Whether or not the webhook should be enabled.Allowable values: true, false
​
url
string
required
The URL of your webhook endpoint.Allowable values: ≤ 512 characters
​
authorizationHeader
string or null
The authorisation header content for the webhook.Allowable values: ≤ 512 characters

​
Response

If your request is successful, you’ll receive a 200 response.
For more detailed information about this request and its response, see the API reference.