Overview

You can configure webhooks at the project level to receive real-time notifications when specific events occur in your SDM workflow. Webhooks enable your systems to respond immediately to changes without requiring polling of our API.

Supported triggers

Job Done

Triggered when a job completes all steps and reaches the final "Download output" page.

Payload:

{
 "job_id": "<UUID of the job>",
 "last_editor": "<email of the last editor or null if none>",
 "completion_date": "<timestamp of when the job was completed>"
}

Step Completed ✨ New

Triggered when an individual step within a job is completed.

Payload:

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "step_id": "123e4567-e89b-12d3-a456-426614174000",
  "step_name": "Extraction",
  "step_type": "extraction",
  "step_number": 2,
  "completion_date": "2025-01-16T14:25:00Z"
}

Configuration

Navigate to the Admin Panel and select Connectors > Project webhooks.

You can edit existing webhooks or create a new one:

1. Enter the Url of the webhook
2. Optionally, you can declare Headers that will be added to the payload.
3. Select the targeted Project
4. And finally the Trigger

Example of Headers:

{
 "token": "xxxxxxxxx"
}

Webhook Delivery

• Method: POST
• Content-Type:  application/json

Limitations

• Dynamic IP addresses: Our webhook requests are sent from a pool of dynamic IP addresses. This means that the specific IP address sending the webhook to your server may change over time without prior notice.
• Why we use Dynamic IP addresses: Using dynamic IP addresses allows us to maintain a highly available and scalable webhook infrastructure.