Register Webhook Callback

Prod Env

https://fmsapi.deltax.la/clients

GET

/api/client/registerCallback/

Register a new webhook callback for the authenticated webhook client token. Creates a callback registration with status pending-activation. Numeric constraints (distanceBetweenCallbacksMins, maxDocumentsPerCallback) are validated against the client's configured limits. The callbackToken is excluded from the response for security.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200CallbackRegistrationUpdateSuccess

application/json

Bodyapplication/json

🟠400BadRequest

🟠401Unauthenticated

🟠403Unauthorized

🟠404NotFound

🔴500InternalServerError

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://fmsapi.deltax.la/clients/api/client/registerCallback/?webhook=trip&url=https%3A%2F%2Fexample.com%2Fwebhook&name=My%20Webhook&callbackToken=secret-token&distanceBetweenCallbacksMins=5&maxDocumentsPerCallback=100&country=MX' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

Success

{"message":"Callback registration updated successfully.","callbackRegistration":{"_id":"66bfb18c40f4231d20eb2154","clientId":"66bfb18c40f4231d20eb2150","name":"My Webhook","callbackURL":"https://example.com/webhook","distanceBetweenCallbacksMins":30,"maxDocumentsPerCallback":100,"enable":true}}

Modified at 2026-07-10 16:46:05

List Rates

List Webhook Callback Registrations