Webhook API

The Webhook object represents an endpoint of an external system that should be invoked for specific events within the Marketplace Platform.

This object contains the following attributes:

Field	Type	Description
id	string	(Read-only) The webhook's unique identifier.
href	string	(Read-only) The relative reference to the object within the API.
description	string	A description of the webhook.
status	enum	The status of the webhook. Allowed values are enabled or disabled.
type	enum	Defines what the webhook is designed for. Allowed values are: validatePurchaseOrderDraft validatePurchaseOrderQuerying validateChangeOrderDraft validateTerminateOrder validateRequest validateAccount selectOrderLines
objectType	enum	Object that triggers the webhook event. Allowed values are Order Request Account
url	string	The webhook endpoint URL. Only https:// endpoints are allowed.
criteria	object	(Read-only) A set of key-value objects required in the webhook payload to trigger the webhook call.
statistics	object	(Read-only) Represents the statistics object containing statistical and debug information regarding webhook executions.
lastSuccess	object	(Read-only) Represents the call object containing the last successful call to the webhook URL.
lastFailure	object	(Read-only) Represents the call object with details of the last failed call to the webhook URL.
lastCall	object	(Read-only) Represents the call object with details of the last call to the webhook URL.
secret	string	The secret used for authorization in the third-party systems. It's returned only once in response to the Create Webhook endpoint.
account	object	(Read-only) Represents the vendor account object.
audit	object	(Read-only) Represents the audit object.

Statistics object

Field	Data	Description
total	number	(Read-only) Total number of calls made from the platform to the external system represented by the Webhook object.
successes	number	(Read-only) Total number of successful calls made from the platform to an external system represented by the Webhook object.
failures	number	(Read-only) Total number of failed calls made from the platform to an external system represented by the Webhook object.
failuresSinceLastSuccess	number	(Read-only) Total number of failed calls since the last successful call made by the platform to an external system, represented by the Webhook object.

Call object

Field	Data	Description
total	number	(Read-only) Total number of calls made from the platform to the external system represented by the webhook object.
successes	number	(Read-only) Total number of successful calls made from the platform to an external system represented by the webhook object.
failures	number	(Read-only) Total number of failed calls made from the platform to an external system represented by the webhook object.
failuresSinceLastSuccess	number	(Read-only) Total number of failed calls since the last successful call made by the platform to an external system, represented by the webhook object.

Example

WEBHOOK API OBJECT

{
  "id": "WBH-5433-8787",
  "href": "/notifications/webhooks/WBH-5433-8787",
  "description": "Webhook for some products"
  "account": {
    "id": "ACC-7362-0233",
    "href": "/accounts/accounts/ACC-7362-0233",
    "name": "Adobe",
    "icon": "/static/ACC-7362-0233/account.png"
  },
  "objectType": "order",
  "type": "validatePurchaseOrderDraft",
  "params": {
    "product.id": "PRD-6233-9657"
  },
  "status": "enabled",
  "url": "https://my-webhook.endpoint.com/validation",
  "secret": "*******************",
  "statistics": {
    "total": 1234,
    "successes": 1132,
    "failures": 101,
    "failuresSinceLastSuccess": 2
  },
  "lastSuccess": {
    "success": true,
    "callTime": "2024-12-12T11:11:11",
    "responseTime": "2024-12-12T11:12:03",
    "httpStatusCode": "200",
    "reasonPhrase": "OK",
    "headers": {
      "Date": "Wed, 15 May 2024 10:16:56 GMT",
    },
    "error": null,
    "response": { ... }
  },
  "lastFailure": {
    "success": true,
    "callTime": "2024-12-12T11:11:11",
    "responseTime": "2024-12-12T11:12:03",
    "status": "401",
    "reasonPhrase": "Auth Error",
    "response": "Unauthenticated",
    "headers": {
      "Date": "Wed, 15 May 2024 10:16:56 GMT",
    },
    "error": "JWT Token was invalid",
    "response": null,
  },
  "lastCall": {
    "success": true,
    "callTime": "2024-12-12T11:11:11",
    "responseTime": "2024-12-12T11:12:03",
    "httpStatusCode": "200",
    "reasonPhrase": "OK",
    "headers": {
      "Date": "Wed, 15 May 2024 10:16:56 GMT",
    },
    "error": null,
    "response": { ... }
  },
  "audit": {
    "created": { "at": "...", "by": { } },
    "updated": { "at": "...", "by": { } }
  },
}