POST Webhook/{eventName}/{primaryKey}
Some tooltip text!
• 2 minutes to read
• 2 minutes to read
POST /api/v1/Webhook/{eventName}/{primaryKey}
Signal webhooks that an event has occurred.
All webhooks listening for the event will be notified.
Online Restricted: ## The Webhook agent is not available in Online by default. Access must be requested specifically when app is registered.
| Path Part | Type | Description |
|---|---|---|
| eventName | string | Name of event to fire. 'entity.verb' For example: 'window.closed', 'button.clicked'. Required |
| primaryKey | int32 | (Optional) Id of entity that is firing event. Can be 0 if not used. Required |
Request Headers
| Parameter Name | Description |
|---|---|
| Authorization | Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type. |
| X-XSRF-TOKEN | If not using Authorization header, you must provide XSRF value from cookie or hidden input field |
| Content-Type | Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json |
| Accept | Content-type(s) you would like the response in: |
| SO-AppToken | The application token that identifies the partner app. Used when calling Online WebAPI from a server. |
Request Body: data
Event data. Not all the data values may be posted to the webhook, depending in webhook type: { 'windowName': 'foo', 'widgets': 123 }
Response:
No Content
| Response | Description |
|---|---|
| 204 | No Content |
Response body: TimeZoneData
Sample request
POST /api/v1/Webhook/{eventName}/{primaryKey}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Sample response
HTTP/1.1 204 No Content
Content-Type: application/json; charset=utf-8
null