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 ABC API Notification endpoints are now available.

The Get Webhooks endpoint returns information about a webhook that has been previously registered. The endpoint response includes the webhook id, name, webhook attributes, status, and a link to the webhook details.

Notification API

Get Webhook

GET /webhooks/{webhookId}

Get a webhook configuration by webhook ID

Authorization

OAuth 2.0 server or user token with the notification.read scope.

Request

Example Request

URI Parameters

The unique identifier {webhookId} representing a specific webhook.

GET /notification/v2/webhooks/11c1fec0-8252-4464-a6d8-9732cee59da7 HTTP/1.1
Host: partner.abcsupply.com
Authorization: Bearer <TOKEN>
Expand

Response

Example Response

{
    "id": "11c1fec0-8252-4464-a6d8-9732cee59da7",
    "secret": "ZjcxYjRjMGYtNDllYi00MTA1LWE1MzMtMTIyY2I3YTAwNzViLTIwMjMtMDktMDhUMTI6MDg6MjkuOTI0LTA0OjAwLTU5MDI0Ng==",
    "type": "order",
    "event": "ORDER_UPDATE",
    "url": "https://abcpartner.com/webhook/events/orders",
    "status": "REGISTERED",
    "activeSince": "2023-09-08T16:08:29.92Z"
}
Expand

Name

Type

Description

id

string

The ID of the generated webhook registration

secret

string

The secret used to check the integrity of the event update received from ABC Supply API.

type

string

The type of webhook (e.g., “order”).

event

string

The webhook events list of the returned webhook (e.g., “ORDER_UPDATE”).

url

string

The URL reference to the webhook.

status

string

The registration status of the webhook (e.g., “REGISTERED”).

activeSince

string

The datetime the webhook was activated, in UTC (e.g., “2023-09-08T16:08:29.92Z”).

HTTP Status Codes

Name

Type

Description

400

Bad Request

Check the Request to make sure the Request Body and Parameters are passed correctly based on the API documentation.

404

Object Not Found

The request returned empty or no object. Please check the object identifier.

Additional Examples

Not Applicable