Register Webhook Endpoint
POST/api/v1/enterprise/eudr/webhooks
Registers an enterprise URL to receive asynchronous compliance events like shipment.linked and polygon.verified. Webhook payloads are cryptographically signed using HMAC-SHA256 with the generated signing secret, and sent in the 'X-AgriBackup-Signature' header for verification.
To verify webhook authenticity:
- Extract the raw POST request body bytes/string.
- Extract the signature value from the 'X-AgriBackup-Signature' HTTP header.
- Calculate the HMAC-SHA256 hash of the raw body using the registered signing secret.
- Hex-encode the calculated hash.
- Perform a constant-time comparison between the hex-encoded hash and the header signature to avoid timing attacks.
Request
Responses
- 200
- 400
- 401
- 403
- 409
- 423
- 429
Webhook successfully registered
Response Headers
The number of requests remaining in the current rate limit window.
The time at which the current rate limit window resets in UTC epoch seconds.
The maximum number of requests you're permitted to make per hour.
Unique request trace identifier
Bad Request (e.g. invalid URL format or unsupported event type)
Response Headers
The maximum number of requests you're permitted to make per hour.
The number of requests remaining in the current rate limit window.
The time at which the current rate limit window resets in UTC epoch seconds.
Unauthorized
Response Headers
The maximum number of requests you're permitted to make per hour.
The number of requests remaining in the current rate limit window.
The time at which the current rate limit window resets in UTC epoch seconds.
Forbidden
Response Headers
The maximum number of requests you're permitted to make per hour.
The number of requests remaining in the current rate limit window.
The time at which the current rate limit window resets in UTC epoch seconds.
Conflict (Webhook for this event and URL already exists)
Response Headers
The maximum number of requests you're permitted to make per hour.
The number of requests remaining in the current rate limit window.
The time at which the current rate limit window resets in UTC epoch seconds.
Locked: Execution thread is currently processing the resource. Wait and retry.
Response Headers
The maximum number of requests you're permitted to make per hour.
The number of requests remaining in the current rate limit window.
The time at which the current rate limit window resets in UTC epoch seconds.
Too Many Requests
Response Headers
The maximum number of requests you're permitted to make per hour.
The number of requests remaining in the current rate limit window.
The time at which the current rate limit window resets in UTC epoch seconds.
Callbacks
- POST shipment.linked
- POST polygon.verified
- POST batch.risk_assessed
- POST dds.submitted
- POST dds.validated
- POST dds.rejected
- POST job.failed
- POST report.ready
POST{$request.body#/targetUrl}
Fired when a batch shipment is successfully anchored.
Callbacks Responses
- 200
Successfully processed by enterprise
POST{$request.body#/targetUrl}
Fired when a polygon ingestion job completes.
Callbacks Responses
- 200
Successfully processed by enterprise
POST{$request.body#/targetUrl}
Fired when Copernicus NDVI risk assessment completes for a batch.
Callbacks Responses
- 200
Successfully processed by enterprise
POST{$request.body#/targetUrl}
Fired when the TRACES NT handshake succeeds and places the payload in the queue.
Callbacks Responses
- 200
Successfully processed by enterprise
POST{$request.body#/targetUrl}
Fired asynchronously by TRACES NT when the DDS is fully validated and clears border checks.
Callbacks Responses
- 200
Successfully processed by enterprise
POST{$request.body#/targetUrl}
Fired asynchronously by TRACES NT if the payload is rejected due to internal cross-checks (e.g., mismatched Operator UUIDs).
Callbacks Responses
- 200
Successfully processed by enterprise
POST{$request.body#/targetUrl}
Critical for alerting the ERP if an asynchronous thread crashes.
Callbacks Responses
- 200
Successfully processed by enterprise
POST{$request.body#/targetUrl}
Fired when an asynchronous bulk report generation job completes successfully.
Callbacks Responses
- 200
Successfully processed by enterprise