v4

OpenAPI 3.1.02026-07-31121440441.0 KB

webhooks

Create a subscription

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.

post/api/v1/hooks/subscriptions/

Headers

Authorizationstring required

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

Request body

idstring

The ID of the subscription.

event_typestring required

The name of the event type associated to the subscription.

target_urlstring required

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

is_enabledboolean

Whether the subscription is enabled or not.

workspace_idstring required

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

Response

Created