Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mapping.travel/llms.txt

Use this file to discover all available pages before exploring further.

Export webhooks let you receive mapping results automatically instead of polling for them. When Mapping.Travel completes a mapping export, it sends a POST request to each active webhook URL you have configured. You can register multiple webhooks, enable or disable them individually, and update them at any time.
All webhook endpoints require authentication. Include your bearer token in the Authorization header.

​
POST /api/v1/export-webhooks

Create a new webhook configuration. 
POST https://api.mapping.travel/api/v1/export-webhooks
Content-Type: application/json

​
Request body

​
url
string
required
The HTTPS endpoint that will receive webhook payloads. Must be a publicly reachable URL.
​
active
boolean
default:"true"
Whether the webhook is active immediately after creation.
​
secret
string
Optional signing secret used to verify webhook payloads on your server.

​
Response

Returns 200 OK with the created webhook configuration.
​
id
string
required
UUID of the webhook configuration.
​
url
string
required
The configured endpoint URL.
​
active
boolean
required
Whether the webhook is currently active.
​
createdAt
string
required
ISO 8601 timestamp of creation.

​
Example

curl -X POST https://api.mapping.travel/api/v1/export-webhooks \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://yourapp.com/webhooks/mapping", "active": true}'

{
  "id": "wh-1a2b3c4d-0000-0000-0000-000000000001",
  "url": "https://yourapp.com/webhooks/mapping",
  "active": true,
  "createdAt": "2026-04-25T09:00:00Z"
}

​
GET /api/v1/export-webhooks

List all webhook configurations for your organization. 
GET https://api.mapping.travel/api/v1/export-webhooks

​
Query parameters

​
activeOnly
boolean
default:"false"
When true, only active webhook configurations are returned.

​
Response

​
webhooks
object[]
required
Array of webhook configuration objects.

​
Example

curl "https://api.mapping.travel/api/v1/export-webhooks?activeOnly=true" \
  -H "Authorization: Bearer <token>"

​
GET /api/v1/export-webhooks/

Retrieve a single webhook configuration by ID. 
GET https://api.mapping.travel/api/v1/export-webhooks/{id}

​
Path parameters

​
id
string
required
UUID of the webhook configuration.

​
Example

curl "https://api.mapping.travel/api/v1/export-webhooks/wh-1a2b3c4d-0000-0000-0000-000000000001" \
  -H "Authorization: Bearer <token>"

​
PUT /api/v1/export-webhooks/

Update an existing webhook configuration. All request body fields replace the current values. 
PUT https://api.mapping.travel/api/v1/export-webhooks/{id}
Content-Type: application/json

​
Path parameters

​
id
string
required
UUID of the webhook configuration to update.

​
Request body

​
url
string
required
New endpoint URL.
​
active
boolean
Whether the webhook should be active.
​
secret
string
Updated signing secret.

​
Example

curl -X PUT \
  "https://api.mapping.travel/api/v1/export-webhooks/wh-1a2b3c4d-0000-0000-0000-000000000001" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://yourapp.com/webhooks/mapping-v2", "active": true}'

​
DELETE /api/v1/export-webhooks/

Delete a webhook configuration. The webhook will stop receiving payloads immediately. 
DELETE https://api.mapping.travel/api/v1/export-webhooks/{id}

​
Path parameters

​
id
string
required
UUID of the webhook configuration to delete.

​
Response

Returns 204 No Content on success. The response body is empty.

​
Example

curl -X DELETE \
  "https://api.mapping.travel/api/v1/export-webhooks/wh-1a2b3c4d-0000-0000-0000-000000000001" \
  -H "Authorization: Bearer <token>"
Deletion is permanent. If you only want to pause delivery temporarily, set active to false using the PUT endpoint instead.