Confirm a subscription | Prolific API

Confirm a subscription to an event type

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

Request

This endpoint expects an object.

secretstringRequired

The secret that was generated when the subscription was created and returned as the X-Hook-Secret header.

Response

Confirmed

event_typestring

The name of the event type associated to the subscription.

target_urlstring

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

workspace_idstring

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

idstring or null

The ID of the subscription.

is_enabledboolean or null

Whether the subscription is enabled or not.

1	curl -X POST https://api.prolific.com/api/v1/hooks/subscriptions/subscription_id/ \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"secret": "TXFOxZKeghHVftzzXTqC6gFpvckPUisuTiICuKoAKSWZ9xVipmv3YRzIZ8TGsZRtFofgnmjEDf4MBORmMTvydeMiABl5hzi_ZTIo_Uwt7ebHh4OH46AzySzR"
6	}'

1	{
2	"event_type": "string",
3	"target_url": "string",
4	"workspace_id": "string",
5	"id": "string",
6	"is_enabled": true
7	}

Authentication

Path Parameters

Request

Response

Errors