Qodex.ai

Webhook api

Number of APIs: 23

Welcome to the documentation of the Webhook API

WARNING : webhooks only available for paying customers. Subscribe to our Pay As you go Plan now

Compatibility guidelines

The HTTP API is versioned with a single number, which is currently 1

This number symbolizes the major version number. New features can be added to the API in the same version number if there is no breaking change.

The version number is present in the url, for instance /webhook/api/v1 for the current version.

Documentation, Pricing and Key generation

You can find the complete documentation for our API at Developers Platform.

Create an account to receive your FREE key in under a minute!

Additionally, explore our pricing plans, access support, view detailed documentation, and follow our comprehensive tutorials.

Authentication

Every endpoints of this API require authentication using an API key.

If you don't have an API Key and you need to use the Container Tracking API, you need to ask Sinay to have one.

To use the API Key, you must add a header named API_KEY with your API Key as a value.

Release note

1.1.0

  • Easy-shipment endpoints

1.0.0

  • Manage webhook

  1. easy-shipment - Add shipments to endpoints POST https://api.sinay.ai/webhook/api/v1/easy-shipment

  2. endpoint-{endpoint_id}-headers - Get Endpoint Headers GET https://api.sinay.ai/webhook/api/v1/endpoint/:endpoint_id/headers

  3. endpoint-{endpoint_id}-replay-missing - Replay Missing Webhooks POST https://api.sinay.ai/webhook/api/v1/endpoint/:endpoint_id/replay-missing

  4. easy-shipment - Delete shipments to endpoints DELETE https://api.sinay.ai/webhook/api/v1/easy-shipment

  5. easy-shipment - Get shipments from endpoints GET https://api.sinay.ai/webhook/api/v1/easy-shipment

  6. easy-shipment - Update shipments to endpoints PUT https://api.sinay.ai/webhook/api/v1/easy-shipment

  7. dashboard - Get dashboard url GET https://api.sinay.ai/webhook/api/v1/dashboard

  8. endpoint-{endpoint_id}-secret-rotate - Rotate Endpoint Secret POST https://api.sinay.ai/webhook/api/v1/endpoint/:endpoint_id/secret/rotate

  9. endpoint-{endpoint_id}-secret - Get Endpoint Secret GET /endhttps://api.sinay.ai/webhook/api/v1point/:endpoint_id/secret

  10. endpoint-{endpoint_id}-stats - Endpoint Stats GET https://api.sinay.ai/webhook/api/v1/endpoint/:endpoint_id/stats?since=<dateTime>&until=<dateTime>