Update a webhook

Updates the details of a given webhook, based on its webhookId.

SecurityCommonAuth
Request
path Parameters
webhookId
required
string <uuid>

The ID of the webhook to work with.

Example: da91434a-4026-42ea-84b8-d0317b64af9c
query Parameters
accountId
string

The ID of the account to work with.

Example: accountId=F50091
Request Body schema: application/json

Body

enabled
required
boolean

Webhook event type availability (whether the webhook is enabled or not).

sharedSecret
string or null <= 36 characters

When provided, this is used to sign the webhook payload and generate the x-em-signature header.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

422

Unable to process the request

429

Too Many Requests

500

Internal Server Error

patch/webhooks/{webhookId}
Request samples
application/json
{
  • "enabled": true,
  • "sharedSecret": "123e4567-e89b-12d3-a456-426614174000"
}
Response samples
application/json
{
  • "id": "da91434a-4026-42ea-84b8-d0317b64af9c",
  • "productId": "3ef24d53-6e22-4103-a16b-d268e4f7346d",
  • "webhookEventTypeId": "da91434a-4026-42ea-84b8-d0317b64af9c",
  • "webhookEventTypeName": "OrderCreated",
  • "accountId": "F50091",
  • "url": "https://api.url.com",
  • "authorizationHeader": "Basic AXVubzpwQDU1dzByYM== ",
  • "enabled": true,
  • "sharedSecret": "123e4567-e89b-12d3-a456-426614174000",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}