Create a subscription | Prolific API

Create a subscription for an event type. When an event is triggered in the Prolific system, the hook will automatically notify the specified target URL. Before creating a subscription, you must ensure that you have created a secret for your workspace.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Request

This endpoint expects an object.

event_typestringRequired

The name of the event type associated to the subscription.

target_urlstringRequired

The URL that the subscription will notify when your event type is triggered.

workspace_idstringRequired

The ID of the workspace we will create the subscription in.

is_enabledbooleanOptional

Whether the subscription is enabled or not.

Response

Created

resultslist of objects

List of all subscriptions.

1	import requests
2
3	url = "https://api.prolific.com/api/v1/hooks/subscriptions/"
4
5	payload = {
6	"event_type": "study.status.change",
7	"target_url": "https://webhook.prolific.co/api/v1/notifications/study-status",
8	"workspace_id": "63722982f9cc073ecc730f6b"
9	}
10	headers = {
11	"Authorization": "Token <token>",
12	"Content-Type": "application/json"
13	}
14
15	response = requests.post(url, json=payload, headers=headers)
16
17	print(response.json())

1	{
2	"results": [
3	{
4	"event_type": "study.status.change",
5	"target_url": "https://webhook.prolific.co/api/v1/notifications/study-status",
6	"workspace_id": "63722982f9cc073ecc730f6b",
7	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
8	"is_enabled": true
9	}
10	]
11	}

Authentication

Request

Response

Errors