Notification API
Subscribe to ABC Supply updates such as order and shipment status. The Notification API allows you to configure webhooks and let ABC Supply push updates to your system in real time.
The Update Webhook endpoint updates the configuration of a webhook that has been previously registered. The request must include the configuration parameters to be updated, such as name, data format, event type, URL, etc. The endpoint response includes the webhook id, name, status, and a link to the webhook registration request.
Notification API
Update Webhook
PATCH /webhooks/{webhookId}
Update an existing webhook configuration
Sandbox
Production
Authorization
OAuth 2.0 server or user token with the notification.write scope.
Request
Name
Type
Description
name
string
The client-provided name for the webhook.
type
enum
The type of webhook (e.g., “ORDER”). Order is the only webhook supported at this time.
events
array
The webhook events list of the returned webhook (e.g., “ORDER_UPDATE”). “ORDER_UPDATE” is the only event supported at this time.
url
string
The URL of the webhook being registered. This is the URL that will be invoked when order status is updated.
URI Parameters
The unique identifier {webhookId} representing a specific webhook.
Example Request
Update Webhook by ID request to modify webhook details
PATCH /api/notification/v2/webhooks/828ec8da-e01a-4085-bee8-7853fd87bd0c HTTP/1.1
Host: partner.abcsupply.com
Authorization: Bearer <TOKEN>
{
"name": "Patched Webhook - Order Update",
"type": "ORDER",
"events": ["ORDER_UPDATE"],
"url": "https://abcpartner.com/webhook/events/orders"
}Response
Example Response
Update Webhook by ID response payload for modified webhook details
{
"id": "828ec8da-e01a-4085-bee8-7853fd87bd0c",
"name": "Patched Webhook - Order Update",
"secret": "NzhhMWJhYmYtYTcyNy00NzA4LTkzNzItMDBmMjVmNWQ0YjQ3LTIwMjUtMDMtMDVUMTU6MTY6MTYuOTgwODQyNDQyWi0xMzUyMTA=",
"status": "REGISTERED",
"links": {
"self": "https://api3-sb.abcsupply.com/test-partners-notification2/api/notification/v2/webhooks/828ec8da-e01a-4085-bee8-7853fd87bd0c"
}
}Name
Type
Description
id
string
The unique ID generated to track the webhook registration.
name
string
The client-provided name for the webhook.
status
string
The base64 secret generated for the webhook registration to ensure the webhook events come from ABC Supply.
link
object
The status of the registration attempt (e.g., “REGISTERED”).
link.self
string
The object containing URL information for the webhook.
secret
string
The URL to the reference of the webhook that was created.
HTTP Status Codes
Code
Status
Description
200
OK
The request and response were successfully sent.
400
Bad Request
Confirm the request body and parameters are formatted correctly.
404
Object Not Found
The webhook with the ID provided was not found.