SpotGo
  1. Webhook
SpotGo
  • Getting started
    • Introduction
    • Authentication
    • Opportunities vs Orders
    • Mappings
  • Order
    • Orders Processing
    • /api/v1/orders/file
      POST
    • /api/v1/orders
      POST
    • /api/v2/orders/{orderId}
      GET
    • /api/v1/orders/{orderId}/file
      GET
  • Opportunity
    • Opportunities (Freight Qoutes)
    • /api/v1/opportunities
      POST
    • /api/v1/opportunities/file
      POST
    • /api/v1/opportunities/image
      POST
    • /api/v1/opportunities/{opportunityId}
      GET
    • /api/v1/opportunities/{opportunityId}/custom
      GET
    • /api/v1/opportunities/{opportunityId}/default
      GET
  • Freight
    • Freight publish
    • /api/v1/freights
      POST
    • /api/v1/freights/{freightId}
      PUT
    • /api/v1/freights/{freightId}
      DELETE
  • Vehicles
    • /api/v1/vehicles
      POST
    • /api/v1/vehicles
      GET
    • /api/v1/vehicles/{vehicleId}
      PUT
    • /api/v1/vehicles/{vehicleId}
      DELETE
    • /api/v1/vehicles/{vehicleId}
      GET
  • Feedback
    • /api/v1/feedback
  • Webhook
    • Webhooks flow
    • /api/v1/webhooks
      POST
    • /api/v1/webhooks
      GET
    • /api/v1/webhooks/{subscriptionId}
      DELETE
  • Documents
    • Documents processing
    • /api/v1/documents
    • /api/v1/documents/{documentId}/file
    • /api/v1/documents/invoice/{documentId}
    • /api/v1/documents/receipt/{documentId}
    • /api/v1/documents/cmr/{documentId}
  • AccountManagement
    • /api/v1/accounts
    • /api/v1/accounts/block
  1. Webhook

Webhooks flow

Wenhooks lets you avoid asking the status every x seconds, instead, you get the information about processed or failed transactions to your endpoint and when only ask for detailed information regarding transaction data. Currently, we provide data about successful and failed transactions immediately after the transaction is processed.

The typical flow:#

Send order data to process
Wait until the webhook pushed to your System endpoint
If the webhook is successful get order information
If the webhook is failed skip order information retrieval

We send requests from the dedicated IPs#

General information for accept webhook:#

Endpoints must be publicly accessible (or IP whitelisted)
Must be HTTPS
Accept POST requests with JSON body
Return 200 OK
If webhook not delivered it tries 3 times with increasing the time between retries

How to accept webhooks#

To accept webhook the endpoint should accept POST method requests and JSON body. Always return 200 OK.
Here are examples of webhook requests:
Test sent when registering new webhook:
{
    "id": "ff79b7b2fb354571b845397a726038e6",
    "subscriptionId": "53559882-b8cd-4f08-b3f4-efc71a9e0254",
    "event": "example.event.publish.test"
}
Success
{
    "id": "771de42bf63f48f6b6e2ffaf253170cd",
    "subscriptionId": "53559882-b8cd-4f08-b3f4-efc71a9e0254",
    "event": "order.process.success"
}
Failed
{
    "id": "ff79b7b2fb354571b845397a726038e6",
    "subscriptionId": "53559882-b8cd-4f08-b3f4-efc71a9e0254",
    "event": "order.process.failure"
}
Modified at 2025-05-06 05:11:56
Previous
/api/v1/feedback
Next
/api/v1/webhooks
Built with