Sitecore API catalog/OrderCloud/Webhooks

Webhooks

Webhooks are HTTP callbacks that allow OrderCloud to send real-time data or notifications to a specified target when an event occurs.

Operations

List webhooks

Request

Security
OAuth2(Required scopes: FullAccessWebhookAdminWebhookReader)
Query
searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ID""Name""Description""Url"
sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"Name""ID""!Name""!ID"
pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

Default:1
pageSizeinteger, <= 100

Number of results to return per page.

Default:20
filtersobject

An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

curl -i -X GET \
  'https://api.ordercloud.io/v1/webhooks?search=string&searchOn=ID&sortBy=Name&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
ItemsArray of objects(Webhook)
Example:
[
  {
    "ID": "",
    "Name": "",
    "Description": "",
    "Url": "",
    "HashKey": "",
    "ElevatedRoles": [ … ],
    "ConfigData": {},
    "BeforeProcessRequest": false,
    "ApiClientIDs": [ … ],
    "WebhookRoutes": [ … ],
    "DeliveryConfigID": "",
    "CustomAuthHeaderName": "",
    "CustomAuthHeaderValue": ""
  }
]
Metaobject(Meta)
Response
{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}