Create/replace a secret

Generate a secret for verifying the request signature header of the subscription payload. If a secret already exists, this call will delete the old secret and create a new one.

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

Request

This endpoint expects an object.

workspace_idstringOptional

The ID of the workspace you are creating the secret in

Response

Generated

idstring

The ID of the secret.

valuestring

The secret value.

workspace_idstring

The ID of the workspace that the secret belongs to.

Errors

4XX

Client Request Error

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

This endpoint expects an object.

The ID of the workspace you are creating the secret in

The ID of the secret.

The ID of the workspace that the secret belongs to.

$	curl -X POST https://api.prolific.com/api/v1/hooks/secrets/ \
>	-H "Authorization: Token <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"workspace_id": "63519c1d5b139662f8cde482"
>	}'

$	curl -X POST https://api.prolific.com/api/v1/hooks/secrets/ \
>	-H "Authorization: Token <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"workspace_id": "63519c1d5b139662f8cde482"
>	}'

1	{
2	"id": "63722971f9cc073ecc730f6a",
3	"value": "cGNqFPb6y0RT3XO9XVSessBDYIbHQ-....",
4	"workspace_id": "63722982f9cc073ecc730f6b"
5	}