Get subscription events

Get all of the events that have triggered for the given subscription.

Authentication

Authorizationstring

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>.

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>`.

Path Parameters

subscription_idstringRequired

Subscription id

Query Parameters

offsetintegerOptional>=0Defaults to 0

limitintegerOptional1-1000Defaults to 100

statusstringOptional

Filter events by status. Accepts a single status or a JSON array of statuses as a string.

resource_idstringOptional

Filter events by the ID of the resource for which the event was sent.

Response

Retrieved

resultslist of objects

All the events triggered for the subscription

1	import requests
2
3	url = "https://api.prolific.com/api/v1/hooks/subscriptions/subscription_id/events/"
4
5	querystring = {"status":"SUCCEEDED"}
6
7	headers = {"Authorization": "<apiKey>"}
8
9	response = requests.get(url, headers=headers, params=querystring)
10
11	print(response.json())

1	{
2	"results": [
3	{
4	"id": "6394cee483e14a167638b36c",
5	"datetime_created": "2022-12-10T18:24:36.041000Z",
6	"datetime_updated": "2022-12-10T18:24:36.041000Z",
7	"event_type": "study.status.change",
8	"resource_id": "6394cee383e14a167638b368",
9	"status": "SUCCEEDED",
10	"target_url": "https://example.com"
11	}
12	]
13	}

Authentication

Path Parameters

Query Parameters

Response

Errors