Webhooks
Authorization JWT-token with a lifetime of 1 hour in header
Successful response containing a list of subscriptions.
The current page of the paginated result set.
1The last page of the paginated result set.
1The number of items per page.
15The total number of subscription items available.
1Unauthorized
The specified resource was not found
Validation error
Connection time-out
Authorization JWT-token with a lifetime of 1 hour in header
The type of subscription to be created. This is a mandatory field and can take values such as:
- individual: For personal accounts.
- numbers: For tracking specific shipment numbers.
- legal: For business accounts, requiring additional company details.
- creator: To tracking all shipments created by the client, regardless of whether they are specified as the sender.
numbersPossible values: The callback URL where webhook notifications will be sent. This is a mandatory field and must be a valid URL. The URL should be capable of receiving POST requests with JSON payloads.
https://api.webhook.test/test_endpointIndicates whether the subscription should be active immediately upon creation. If set to true, the webhook will start sending notifications as soon as the subscription is confirmed. Defaults to false if not provided.
falseExample: trueThe phone number associated with the subscription.
This parameter is required when the subscription type is individual.
The phone number must be in international format, for example, 380637445555.
380630000001Webhook Authorization Token: Maximum Length 600 Characters
k4MzM1NywiZXhwIjoxNzM3Specifies the header name used to pass the secretToken in webhook requests.
X-Custom-TokenA list of event types that the subscription will listen to. This parameter allows you to specify which events should trigger webhook notifications. If no value is provided, the subscription will be created for all event types by default.
The list of supported event types includes:
ReadyToShip: The shipment has been created and is ready for dispatch.Deleted: The shipment has been deleted.ParcelPlaceRemoved: A parcel has been removed from the shipment.Received: The shipment has been received by the recipient.MoneyTransfer: A money transfer related to the shipment has been created.MoneyTransferReceived: The money transfer related to the shipment has been paid out to the recipient.Returned: The shipment is being returned or has been returned to the sender.Refused: The recipient has refused to accept the shipment.Redirecting: The shipment is being redirected to another address or branch.Utilization: The shipment has been disposed of.Redelivery: A repeat delivery attempt for the shipment has been scheduled.UndeliveryReason: A non-delivery reason has been recorded.ChangeTime: The delivery date or time has been changed.ArrivalSC: The shipment has arrived at the sorting center.TransferToPartner: The shipment has been handed over to a partner for further delivery.LoadingCourier: The shipment has been loaded onto the courier’s vehicle.ArrivalSenderWarehouse: The shipment has arrived at the sender’s warehouse.DepartureSenderWarehouse: The shipment has departed from the sender’s warehouse.InCityRecipient: The shipment has arrived in the recipient’s city.AwaitingOnDivision: The shipment is waiting at the branch or pickup point.
🔸This field accepts only the event types listed above.
Any values outside of this list are not supported and must not be provided.
Determines if email warnings should be sent in case of issues with the specified webhook URL.
If enabled, the system will send notifications about delivery problems or other errors.
Defaults to false.
falseExample: trueThe email address where warnings about endpoint issues will be sent.
It is required if sendWarnings is set to true.
The email address should be valid and active to ensure delivery of warnings.
example@novadigital.comA list of company tax identification numbers relevant to the subscription type legal.
This parameter is required for legal subscriptions and is essential to verify the company's identity.
Each TIN should be a valid UUID.
The type of subscription to be created.
The callback URL where webhook notifications will be sent.
Indicates whether the subscription is active immediately after creation.
The phone number associated with the subscription.
A list of event types that the subscription will listen to.
Determines if email warnings should be sent for webhook delivery issues.
The email address where warnings will be sent.
A list of company tax identification numbers for legal subscriptions.
Webhook authorization token used to validate incoming webhook requests.
🔸The token is optional and, if provided, must consist only of alphanumeric characters.
k4MzM1NywiZXhwIjoxNzM3Pattern: ^[A-Za-z0-9]+$Specifies the name of the HTTP header used to transmit the secretToken in webhook requests.
If secretTokenHeaderName is provided and is not null, its value is used as the header name for transmitting the secretToken.
If secretTokenHeaderName is not provided in the request, or is explicitly set to null, the default header name X-NP-Key is used.
Validation requirements:
- Only Latin letters, digits, and hyphens are allowed.
- Must not start or end with a hyphen.
- Must not contain spaces or any other special characters.
🔸This field is optional
X-Custom-TokenPattern: A-Za-z0-9Subscription successfully created.
Unauthorized
The specified resource was not found
Validation error
Connection time-out
Authorization JWT-token with a lifetime of 1 hour in header
The unique identifier of the subscription you want to update. This is a mandatory path parameter used to specify the subscription to be modified.
a866fe22-8134-45c7-bfe9-3cf348415e26The new callback URL for webhook notifications. This URL must be reachable and capable of handling POST requests.
https://api.example.com/updated-webhookSpecifies whether the subscription is currently active. Set to true to activate the subscription, or false to deactivate it.
falseThe type of subscription created.
falseA list of event types that the subscription will listen for. You can specify which events should trigger webhook notifications.
nullIndicates if the system should send email warnings about issues with the specified webhook URL. Set to true to enable warnings.
falseThe email address for sending warnings. This field is necessary if sendWarnings is set to true.
admin@example.comWebhook authorization token used to validate incoming webhook requests.
🔸The token is optional and, if provided, must consist only of alphanumeric characters.
k4MzM1NywiZXhwIjoxNzM3Pattern: ^[A-Za-z0-9]+$Specifies the name of the HTTP header used to transmit the secretToken in webhook requests.
If secretTokenHeaderName is provided and is not null, its value is used as the header name for transmitting the secretToken.
If secretTokenHeaderName is not provided in the request, or is explicitly set to null, the default header name X-NP-Key is used.
Validation requirements:
- Only Latin letters, digits, and hyphens are allowed.
- Must not start or end with a hyphen.
- Must not contain spaces or any other special characters.
🔸This field is optional
X-Custom-TokenPattern: A-Za-z0-9Subscription successfully updated.
The unique identifier for the updated subscription.
a866fe22-8134-45c7-bfe9-3cf348415e26The subscription type, such as individual, numbers, or legal.
individualThe updated callback URL for the subscription.
https://api.example.com/updated-webhookIndicates if the subscription is currently active.
falseDeprecated. Legacy field kept for backward compatibility. Use isActive instead.
falseThe phone number associated with the subscription, if applicable.
380001234567Unique user identifier
11a111a1-a1a1-11aa-a111-111111aa1111A list of event types the subscription listens to.
Deprecated. Legacy field kept for backward compatibility. Use eventTypes instead.
Indicates whether email warnings are sent for incorrect endpoint operations.
falseDeprecated. Legacy field kept for backward compatibility. Use sendWarnings instead.
falseThe email address used for sending warnings.
admin@example.comDeprecated. Legacy field kept for backward compatibility. Use warningEmail instead.
admin@example.comSpecifies the Content-Type used for webhook request payloads.
The default value is application/json.
application/jsonThe list of company tax identification numbers of a legal entity associated with the subscription.
Deprecated. Legacy field kept for backward compatibility. Use companyTins instead.
Webhook authorization token used to validate incoming webhook requests.
🔸The token is optional and, if provided, must consist only of alphanumeric characters.
k4MzM1NywiZXhwIjoxNzM3Pattern: ^[A-Za-z0-9]+$Deprecated. Legacy field kept for backward compatibility. Use secretToken instead.
k4MzM1NywiZXhwIjoxNzM3Pattern: ^[A-Za-z0-9]+$Specifies the name of the HTTP header used to transmit the secretToken in webhook requests.
🔸This field is optional and, if provided, must contain only Latin letters, digits, and hyphens, must not start or end with a hyphen, and must not contain spaces or other special characters.
A-Za-z0-9Deprecated. Legacy field kept for backward compatibility. Use secretTokenHeaderName instead.
X-Custom-TokenThe timestamp when the subscription was last updated.
2025-04-14T07:53:38.970000ZDeprecated. Legacy field kept for backward compatibility. Use updatedAt instead.
2025-04-14T07:53:38.970000ZThe timestamp when the subscription was created.
2025-04-14T07:53:38.970000ZDeprecated. Legacy field kept for backward compatibility. Use createdAt instead.
2025-04-14T07:53:38.970000ZUnauthorized
The specified resource was not found
Validation error
Connection time-out
Authorization JWT-token with a lifetime of 1 hour in header
The unique identifier of the subscription to be deleted. This is a required path parameter that identifies the specific subscription you wish to remove.
a866fe22-8134-45c7-bfe9-3cf348415e26Subscription successfully deleted.
Unauthorized
The specified resource was not found
Validation error
Connection time-out
Authorization JWT-token with a lifetime of 1 hour in header
The unique identifier of the subscription to which shipment numbers will be added. This is a required path parameter.
a866fe22-8134-45c7-bfe9-3cf348415e26A list of shipment numbers to be added to the subscription.
["20600000179995","20600000179992"]Numbers successfully added to the subscription.
A confirmation message indicating successful addition of numbers.
Numbers successfully added to the subscription.The list of numbers that were successfully added to the subscription.
["SHPL2666212296","SHPL6628713835"]The list of numbers that could not be added (e.g., invalid or already linked).
Unauthorized
The specified resource was not found
Validation error
Connection time-out
Authorization JWT-token with a lifetime of 1 hour in header
The unique identifier of the subscription to which shipment numbers will be deleted. This is a required path parameter.
a866fe22-8134-45c7-bfe9-3cf348415e26A list of shipment numbers to be deleted to the subscription.
["20600000179995","20600000179992"]Numbers successfully deleted with subscription.
A confirmation message indicating successful deleted of numbers.
Unauthorized
The specified resource was not found
Validation error
Connection time-out
{
"number": "SHPL0000000001",
"scheduled_delivery_date": "2024-11-20T20:03:00.000000Z",
"history_tracking": [
{
"code": "4",
"code_name": "On the way",
"country_code": "UA",
"settlement": "Kyiv",
"date": "2024-11-19T09:32:05.000000Z"
},
{
"code": "112",
"code_name": "Change of delivery date",
"country_code": "",
"settlement": "",
"date": "2024-11-19T09:33:56.000000Z"
}
]
}Authorization JWT-token with a lifetime of 1 hour in header
Test shipment number always SHPL0000000001
["SHPL0000000001"]The unique identifier for the created subscription.
f5300824-58a9-496b-ac3b-bee156844fdfUnique user identifier
11a111a1-a1a1-11aa-a111-111111aa1111Test webhook was sent successfully.
Confirmation message about successful test
trueUnauthorized
The specified resource was not found
Validation error
Connection time-out
Last updated