Skip to main content
Deprecated. This endpoint is kept for backwards compatibility for one release. New integrations should use /api/v1/webhook-subscriptions, which adds:
  • Per-subscription event filtering (MAPPING_COMPLETED, MAPPING_ERROR_RESOLVED, INVENTORY_DUPLICATE_RESOLVED)
  • HMAC-SHA256 request signing
  • Bounded async retries (1m → 5m → 30m → dead-letter)
  • Persisted delivery history with the /deliveries endpoint
  • Synthetic test events via /test
Existing rows created via this endpoint are visible from both APIs; the same id works for both paths.
The legacy endpoint registers HTTPS endpoints that receive mapping.completed deliveries when a mapping job finishes. It fires fire-and-forget with no retry and no signing.
All endpoints require an API key in the X-API-Key header.

POST /api/v1/export-webhooks

Create a new webhook configuration.

Request body

string
Human-readable label for the webhook.
string
required
HTTPS endpoint that will receive payloads. Must use https:// and resolve to a non-private address.
string
Header name we should attach to every request (e.g., X-API-Key).
string
Header value paired with apiKeyName. Stored encrypted at rest.
object
Extra headers to attach to every request as a key-value map.
string
default:"ACTIVE"
ACTIVE or INACTIVE.

Example


GET /api/v1/export-webhooks

List webhook configurations for the organization.
boolean
default:"false"
When true, only ACTIVE configurations are returned.

GET /api/v1/export-webhooks/

Retrieve a single webhook configuration.

PUT /api/v1/export-webhooks/

Replace the configuration. All fields in the request body overwrite the current values.

DELETE /api/v1/export-webhooks/

Permanently delete the configuration. Returns 204 No Content.
Deletion is permanent. To pause delivery without deleting, PUT with status: "INACTIVE".

What this endpoint does NOT support

These belong to the new endpoint:
  • Choosing which events to subscribe to (legacy only fires mapping.completed)
  • Signature verification headers (no X-Webhook-Signature)
  • Automatic retries on failure (one attempt only; failures are logged but not retried)
  • Delivery history (no /deliveries endpoint)
  • Test events (no /test endpoint)
  • Per-event tier gating
For any of the above, switch to /api/v1/webhook-subscriptions.