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 a list of information for all webhooks that have been previously registered. The endpoint response includes a list of the webhooks and their details, including ID, name, status, and other webhook attributes.

Notification API

Get Webhooks

GET /webhooks

Get webhook configurations

Authorization

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

Request

Example Request

Request to get all previously registered webhooks.

GET /notification/v2/webhooks 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 by partners to check the integrity of the event update received from ABC Supply.

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

enum

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

activeSince

string

The datetime the webhook was activated (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