Notification format

When an event that a subscription is created for occurs, a notification is sent to the URL specified in the subscription. It will contain all data about the object as of the event time.

Notifications are sent in JSON format.

{
  "events":
  [
    {Data about event 1},
    {Data about event 2},
    {Data about event N}
  ]
}

Data included in a notification depends on the event type.

Example of the POOL_CLOSED notification body

{
  "uuid": "uuid-1",
  "event_time": "2020-02-14T12:22:58",
  "project_id": "project-1",
  "pool_id": "pool-1",
  "close_reason": "MANUAL",
  "webhook_subscription_id":"subscription-1",
  "type":"POOL_CLOSED"
}
Key descriptions

Key

Value

Data type

uuid

Unique event ID.

String

event_time

Time when the event occurs.

String

project_id

ID of the project that the pool was created for.

String

pool_id

ID of the pool that the subscription was created for.

String

close_reason

Reason for closing the pool.

String

webhook_subscription_id

ID of the subscription.

String

type

Event type.

Possible value: POOL_CLOSED — The pool is closed.

String

Key

Value

Data type

uuid

Unique event ID.

String

event_time

Time when the event occurs.

String

project_id

ID of the project that the pool was created for.

String

pool_id

ID of the pool that the subscription was created for.

String

close_reason

Reason for closing the pool.

String

webhook_subscription_id

ID of the subscription.

String

type

Event type.

Possible value: POOL_CLOSED — The pool is closed.

String

Example of the ASSIGNMENT_ notification body

{
  "uuid": "uuid-1",
  "event_time": "2020-02-14T12:23:05",
  "project_id": "project-1",
  "pool_id": "pool-1",
  "task_suite_id": "task suite-1",
  "assignment_id": "assignment-1",
  "webhook_subscription_id":"subscription-1",
  "type":"ASSIGNMENT_CREATED"
}
Key descriptions

Key

Value

Data type

uuid

Unique event ID.

String

event_time

Time when the event occurs.

String

project_id

ID of the project that the pool was created for.

String

pool_id

ID of the pool that the subscription was created for.

String

task_suite_id

ID of a task suite.

String

assignment_id

ID of the task suite assignment to a user.

String

webhook_subscription_id

ID of the subscription.

String

type

Event type.

Acceptable values:

  • 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

Key

Value

Data type

uuid

Unique event ID.

String

event_time

Time when the event occurs.

String

project_id

ID of the project that the pool was created for.

String

pool_id

ID of the pool that the subscription was created for.

String

task_suite_id

ID of a task suite.

String

assignment_id

ID of the task suite assignment to a user.

String

webhook_subscription_id

ID of the subscription.

String

type

Event type.

Acceptable values:

  • 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

Example of the DYNAMIC_OVERLAP_COMPLETED notification body

{
  "uuid": "uuid-1",
  "event_time": "2020-02-14T12:23:05",
  "project_id": "project-1",
  "pool_id": "pool-2",
  "task_id": "task-1",
  "confidence": 0.155,
  "webhook_subscription_id":"subscription-1",
  "type":"DYNAMIC_OVERLAP_COMPLETED",
  "assignment_ids": ["assignment-1", "assignment-2"],
  "output_values": {
    "field_one": "value-1"
    }
  }
}
Key descriptions

Key

Value

Data type

uuid

Unique event ID.

String

event_time

Time when the event occurs.

String

project_id

ID of the project that the pool was created for.

String

pool_id

ID of the pool that the subscription was created for.

String

task_id

Task ID.

String

confidence

Confidence in the aggregate response.

Number

webhook_subscription_id

ID of the subscription.

String

type

Event type.

Possible value: DYNAMIC_OVERLAP_COMPLETED — An aggregated score appeared after dynamic overlap.

String

assignment_ids

IDs of task suite assignments to users.

Array

output_values

Output data fields that contain the task text (field_one) and response.

Number, String, Array

Key

Value

Data type

uuid

Unique event ID.

String

event_time

Time when the event occurs.

String

project_id

ID of the project that the pool was created for.

String

pool_id

ID of the pool that the subscription was created for.

String

task_id

Task ID.

String

confidence

Confidence in the aggregate response.

Number

webhook_subscription_id

ID of the subscription.

String

type

Event type.

Possible value: DYNAMIC_OVERLAP_COMPLETED — An aggregated score appeared after dynamic overlap.

String

assignment_ids

IDs of task suite assignments to users.

Array

output_values

Output data fields that contain the task text (field_one) and response.

Number, String, Array