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:
id
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.
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.
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.
total
number
(Read-only) Total number of calls made from the platform to the external system represented by the Webhook object.
successes
number
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.
(Read-only) Total number of successful calls made from the platform to an external system represented by the webhook 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": { } }
},
}Id of webhook to update
RQL select statements
OK
Forbidden
Not Found
Internal Server Error
No content
PUT /public/v1/notifications/webhooks/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 417
{
"webhookId": "text",
"description": {
"value": "text"
},
"url": {
"value": "https://example.com"
},
"criteria": {
"value": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"secret": {
"value": "text"
},
"lastCall": {
"value": {
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"httpStatusCode": "Continue",
"reasonPhrase": "text",
"success": true,
"response": "text",
"error": "text",
"headers": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"url": "text",
"description": "text",
"status": "Enabled",
"type": "ValidatePurchaseOrderDraft",
"secret": "text",
"statistics": {
"total": 1,
"successes": 1,
"failures": 1,
"failuresSinceLastSuccess": 1
},
"objectType": "Order",
"account": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"object": {
"id": "text",
"name": "text",
"icon": "text"
},
"criteria": [
{
"key": "text",
"value": "text"
}
],
"lastSuccess": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
},
"lastFailure": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
},
"lastCall": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
}
}Id of webhook to be deleted
No Content
No content
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/notifications/webhooks/{id}/enable HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
Id of webhook to be deleted
No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/notifications/webhooks/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
OK
Not Found
GET /public/v1/notifications/webhooks/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"url": "text",
"description": "text",
"status": "Enabled",
"type": "ValidatePurchaseOrderDraft",
"secret": "text",
"statistics": {
"total": 1,
"successes": 1,
"failures": 1,
"failuresSinceLastSuccess": 1
},
"objectType": "Order",
"account": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"object": {
"id": "text",
"name": "text",
"icon": "text"
},
"criteria": [
{
"key": "text",
"value": "text"
}
],
"lastSuccess": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
},
"lastFailure": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
},
"lastCall": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
}
}RQL select statements
OK
No content
Created
No content
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/notifications/webhooks HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
OK
GET /public/v1/notifications/webhooks HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"url": "text",
"description": "text",
"status": "Enabled",
"type": "ValidatePurchaseOrderDraft",
"secret": "text",
"statistics": {
"total": 1,
"successes": 1,
"failures": 1,
"failuresSinceLastSuccess": 1
},
"objectType": "Order",
"account": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"object": {
"id": "text",
"name": "text",
"icon": "text"
},
"criteria": [
{
"key": "text",
"value": "text"
}
],
"lastSuccess": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
},
"lastFailure": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
},
"lastCall": {
"success": true,
"callTime": "2026-01-01T00:00:00.000Z",
"responseTime": "2026-01-01T00:00:00.000Z",
"headers": "text",
"error": "text",
"response": "text",
"reasonPhrase": "text",
"httpStatusCode": "Continue"
}
}
]
}Id of webhook to be deleted
No Content
No content
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/notifications/webhooks/{id}/disable HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content