Sign in
Evaluators

Set an evaluator's webhook subscriptions

Set (replace) all webhook subscriptions on an evaluator. This is an idempotent operation.

Payload Requirements

  • subscriptions is required, with at most one entry per webhook_id.
  • Each entry must subscribe to at least one evaluator event (EVALUATOR_VERSION_CREATED); other events are rejected with a 422.
  • Each webhook_id must be a webhook in the evaluator's organization; unknown webhooks yield a 404.
  • At most 200 webhooks may subscribe to the same event on an evaluator; requests that would exceed this limit are rejected with a 422.

Subscriptions not included in the request are removed. Pass an empty array to detach every webhook from the evaluator.

<Warning>This endpoint is in alpha, read more here.</Warning>

put/v2/evaluators/{evaluator_id}/webhook-subscriptions

Path parameters

evaluator_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique evaluator identifier (base64)

Request body

Example request

{
  "subscriptions": [
    {
      "webhook_id": "RW50aXR5OjEyMzQ1"
    }
  ]
}

Response

The complete set of webhook subscriptions attached to the resource

Example response

{
  "subscriptions": [
    {
      "webhook_id": "RW50aXR5OjEyMzQ1"
    }
  ]
}

Changes

Changed in 1 of the 16 revisions of this API.1

Of the 16 revisions, 1 has no diff computed.