POST
/v2/webhooksBetaCreate a webhook
Registers an HTTPS endpoint that receives a signed POST when one of your risk jobs reaches a terminal state. The signing secret is returned only on this response — store it immediately.
Beta. This endpoint is available for production integrations, but fields, categories, and credit weights may change without a version pin.
Base URL
https://api.relativity6.comAuthentication
Send your API key in the x-api-key header. Send your organization API key.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
| url | string | Required | HTTPS URL to receive deliveries. HTTP is rejected. |
| events | string[] | Optional | Lifecycle events to receive. Defaults to both terminal events when omitted.job.completed · job.failed |
| description | string | Optional | Optional label for this subscription (max 256 characters). |
Response
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | Required | Subscription id. Use it to delete the webhook later. |
| url | string | Required | The registered HTTPS endpoint. |
| events | string[] | Required | Events this subscription receives. |
| description | string | Optional | Optional label. |
| active | boolean | Required | Whether the subscription is active. |
| createdAt | string (ISO 8601) | Optional | When the subscription was created. |
| secret | string | Required | Signing secret. Returned only once — never on list. |
Errors
| Status | Description |
|---|---|
| 201 | Subscription created. Persist the secret immediately. |
| 400 | Invalid URL or events (HTTPS is required). |
| 401 | Missing or invalid API key. |
| 403 | Organization is not authorized for Risk API v2. |
| 500 | Server error. |