List all subscribable event types

curl https://api.prolific.com/api/v1/hooks/event-types/ \
     -H "Authorization: Token <token>" \
     -H "Content-Type: application/json"

{
  "results": [
    {
      "event_type": "study.status.change",
      "description": "Triggered when the status of a study changes, e.g., from draft to live."
    },
    {
      "event_type": "participant.submission.created",
      "description": "Occurs when a participant submits a response to a study."
    },
    {
      "event_type": "payment.processed",
      "description": "Fires when a payment to a participant has been successfully processed."
    },
    {
      "event_type": "study.completed",
      "description": "Indicates that a study has been fully completed by all participants."
    }
  ]
}

You can subscribe to any of the event types defined in this response.

Authentication

AuthorizationToken

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.

Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.

If your token is leaked, delete it and create a new one directly in the app.

In your requests add Authorization header with the value Token <your token>.

Response

List of event types that can be subscribed to.

resultslist of objects

Errors

4XX

Client Request Error

$	curl https://api.prolific.com/api/v1/hooks/event-types/ \
>	-H "Authorization: Token <token>" \
>	-H "Content-Type: application/json"

1	{
2	"results": [
3	{
4	"event_type": "study.status.change",
5	"description": "Triggered when the status of a study changes, e.g., from draft to live."
6	},
7	{
8	"event_type": "participant.submission.created",
9	"description": "Occurs when a participant submits a response to a study."
10	},
11	{
12	"event_type": "payment.processed",
13	"description": "Fires when a payment to a participant has been successfully processed."
14	},
15	{
16	"event_type": "study.completed",
17	"description": "Indicates that a study has been fully completed by all participants."
18	}
19	]
20	}