Receiving

Having successfully subscribed to our desired event type, our target url will be notified each and every time the associated event is triggered. You can react to this event in any way you see fit. The response body will adhere to the following structure:

submission.status.change

1 {
2   "resource_id": "<resource_id>",
3   "event_type": "submission.status.change",
4   "participant_id": "<participant_id>",
5   "status": "<status>",
6 }

Field	Description
resource_id	The unique identifier of the submission resource.
event_type	The type of event `submission.status.change`.
participant_id	The unique identifier of the participant associated with the submission.
status	The new status of the submission.

study.status.change

1 {
2   "resource_id": "<resource_id>",
3   "event_type": "study.status.change",
4   "metadata": {},
5   "status": "<status>",
6 }

Field	Description
resource_id	The unique identifier of the study resource.
event_type	The type of event `study.status.change`.
metadata	Any additional metadata related to the study’s status change.
status	The new status of the study.

study.progress.change

1 {
2   "resource_id": "<resource_id>",
3   "event_type": "study.progress.change",
4 }

Field	Description
resource_id	The unique identifier of the study resource.
event_type	The type of event `study.progress.change`.

study.has_high_return_rate

1 {
2   "resource_id": "<resource_id>",
3   "event_type": "study.has_high_return_rate",
4   "metadata": {},
5 }

Field	Description
resource_id	The unique identifier of the study resource. For sub-studies, this will be the parent study ID.
event_type	The type of event `study.has_high_return_rate`.
metadata	Any additional metadata related to the study’s high return rate.

1	{
2	"resource_id": "<resource_id>",
3	"event_type": "submission.status.change",
4	"participant_id": "<participant_id>",
5	"status": "<status>",
6	}

1	{
2	"resource_id": "<resource_id>",
3	"event_type": "study.status.change",
4	"metadata": {},
5	"status": "<status>",
6	}

1	{
2	"resource_id": "<resource_id>",
3	"event_type": "study.progress.change",
4	}

1	{
2	"resource_id": "<resource_id>",
3	"event_type": "study.has_high_return_rate",
4	"metadata": {},
5	}