Get a subscription

To get subscription data, send a GET request to the /webhook-subscriptions/<subscription ID> resource.

Request

GET /api/v1/webhook-subscriptions/<subscription ID>
Host: https://sandbox.toloka.yandex.ru
Authorization: OAuth <OAuth token>

Response

Contains information about the requested subscription in JSON format.

[
  {
     "webhook_url": "https://awesome-requester.com/toloka-webhook",
     "event_type": "ASSIGNMENT_CREATED",
     "pool_id": "121212",
     "id": "webhook-subscription-1",
     "created": "2020-02-03T15:00:00"
  }
]
Key descriptions
Key Value Data type

webhook_url

The URL that notifications will be sent to.

String

event_type

Event type.

Acceptable values:

  • POOL_CLOSED — The pool is closed.
  • DYNAMIC_OVERLAP_COMPLETED — An aggregated result appeared after dynamic overlap.
  • ASSIGNMENT_CREATED — A task was created.
  • ASSIGNMENT_SUBMITTED — A task is completed and waiting for acceptance by the requester.
  • ASSIGNMENT_SKIPPED — A task was taken by the performer who then skipped it and won't return to it.
  • ASSIGNMENT_EXPIRED — A task was taken by the performer who failed to complete it within the time allowed or rejected it before it expired.
  • ASSIGNMENT_APPROVED — A task was completed by the performer and approved by the requester.
  • ASSIGNMENT_REJECTED — A task was completed by the performer but rejected by the requester.

String

pool_id

ID of the pool that the subscription was created for.

String

id

ID of the subscription.

String

created

The date and time when the subscription was created (UTC). It uses ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

Key Value Data type

webhook_url

The URL that notifications will be sent to.

String

event_type

Event type.

Acceptable values:

  • POOL_CLOSED — The pool is closed.
  • DYNAMIC_OVERLAP_COMPLETED — An aggregated result appeared after dynamic overlap.
  • ASSIGNMENT_CREATED — A task was created.
  • ASSIGNMENT_SUBMITTED — A task is completed and waiting for acceptance by the requester.
  • ASSIGNMENT_SKIPPED — A task was taken by the performer who then skipped it and won't return to it.
  • ASSIGNMENT_EXPIRED — A task was taken by the performer who failed to complete it within the time allowed or rejected it before it expired.
  • ASSIGNMENT_APPROVED — A task was completed by the performer and approved by the requester.
  • ASSIGNMENT_REJECTED — A task was completed by the performer but rejected by the requester.

String

pool_id

ID of the pool that the subscription was created for.

String

id

ID of the subscription.

String

created

The date and time when the subscription was created (UTC). It uses ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String