GET
/
webhook
curl --request GET \
  --url https://prod01.oms.fabric.inc/api/v2/webhook/ \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
[
  {
    "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.

Query Parameters

​
offset
integer
required
​
limit
integer
required
​
eventType
string
​
apiVersion
string

Response

200
application/json
List of webhook definitions
​
target
string
required

target url

​
protocol
string
required
​
source
string
required

Source of event triggers

​
events
string[]
required

List of events for which the webhook need to trigger the target

​
requestType
enum<string>
required

List of events for which the webhook need to trigger the target

Available options:
POST,
PUT,
PATCH,
GET,
DELETE
​
webhookId
string
​
tenantId
string
​
targetApiKey
string

Api key of the target service , if authentication is required

​
apiVersion
string
deprecated
​
format
string

Content-Type of request body while triggering Webhook

​
callbackUrl
string
deprecated
​
createdDate
string
​
updatedDate
string

Was this page helpful?

Query webhook event logCreate webhook definition