PATCH
/
webhook
/
{webhookId}
curl --request PATCH \
  --url https://prod01.oms.fabric.inc/api/v2/webhook/{webhookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "tenantId": "<string>",
  "target": "http://www.test.com",
  "targetApiKey": "adfasdWdsaQFSsdf",
  "protocol": "HTTP",
  "source": "OMS",
  "apiVersion": "<string>",
  "format": "application/json",
  "callbackUrl": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "events": "[ORDER_CREATED]",
  "requestType": "POST"
}'
{
  "webhookId": "<string>",
  "tenantId": "<string>",
  "target": "http://www.test.com",
  "targetApiKey": "adfasdWdsaQFSsdf",
  "protocol": "HTTP",
  "source": "OMS",
  "apiVersion": "<string>",
  "format": "application/json",
  "callbackUrl": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "events": "[ORDER_CREATED]",
  "requestType": "POST"
}

The following endpoint is deprecated.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

​
webhookId
string
required

Body

application/json

Request model for Webhook Definition

Response

200
application/json

Returns Webhook Definition that is successfully updated

Request model for Updating Webhook Definition