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.
Webhooks are customizable HTTP callbacks triggered by events and can integrate with your app or third-party APIs. They notify your application of key events, like order or shipment updates. ABC Supply sends HTTP POST requests to your webhook-configured URL every time an order status update occurs.
Use the Register Webhook endpoint to subscribe your URL for real-time updates. Specify the desired webhook type in the request. The endpoint’s response provides registration details, including ID, name, status, and a link to webhook details.
NOTE: A maximum of five webhooks can be registered with an application.
Notification API
Register Webhook
POST /webhooks
Register a new webhook and subscribe to ABC Supply order updates
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.
Example Request
Register Webhook request for provided webhook details
{
"name": "New Order Update",
"type": "ORDER",
"events": ["ORDER_UPDATE"],
"url": "https://abcpartnerwebsite.com/webhook/events/orders"
}Response
Example Response
Register Webhook response payload for provided webhook details
{
"id": "827dff22-502a-47be-b56d-2423e4c2ed8d",
"name": "New Order Update",
"secret": "Y2I3MjNhZGEtMDBhMC00YmFhLWJmMzQtOTBlYzJiYWVhZmUwLTIwMjUtMDItMDVUMTk6MTU6MDMuMzc4OTYzMTU2Wi01MzI1MzM=",
"status": "REGISTERED",
"links": {
"self": "https://api3-sb.abcsupply.com/test-partners-notification2/api/notification/v2/webhooks/827dff22-502a-47be-b56d-2423e4c2ed8d"
}
}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 status of the registration attempt (e.g., “REGISTERED”).
links
object
The object containing URL information for the webhook.
links.self
string
The URL to the reference of the webhook that was created.
secret
string
The base64 secret generated for the webhook registration to ensure the webhook events come from ABC Supply.
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.