For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Go to app
DocumentationAPI Reference
DocumentationAPI Reference
  • Get Started
    • Overview
    • Terminology
    • API Fundamentals
    • Your first data collection
  • Core Concepts
    • Finding the right participants
    • Reviewing submissions and rewards
    • Testing study set up
    • Monitoring study progress
    • Managing high loads
    • Running AI Task Builder Batches via Prolific’s API
  • Cookbooks
    • Longitudinal or multi-part studies
    • Collecting original data with AI Task Builder Collections
  • Tooling
    • Prolific CLI
Go to app
LogoLogo
Core Concepts

Monitoring study progress

|View as Markdown|Open in Claude|
Was this page helpful?
Previous

Testing study set up

Next

Managing high loads

Prolific provides webhook events for updates to your workspace, such as study.status.change, study.progress.change and submission.status.change.

1

List event types

Make a note of the event type you’d like to subscribe to. You’ll need this later when setting up a subscription.

2

Create a secret

Secrets are used to verify the authenticity of our webhook requests to your system. It allows you to prove we have sent them and the payload hasn’t been fiddled with.

This will create a new secret for your workspace and be returned in the response body. Keep this safe, and note that you can only have one active secret per workspace at a time.

3

Subscribe to an event

If successful, the endpoint will return a response that includes:

  • An id field in the body - This is the unique identifier for your subscription.
  • An X-Hook-Secret header - Used to confirm your intention to subscribe to the desired event type.

Make a note of both the id and the X-Hook-Secret. We’ll use these to confirm our intention to subscribe to the desired event type.

Note

target_url must use https:// and be publicly accessible.

4

Confirm the subscription

Replace <subscription_id> with the value of the X-Hook-Secret header in the previous subscription request.

If subscription confirmation is successful, you should receive a 200 status code.

From here, whenever the specified event occurs, the target URL will be called. The data sent in the call will depend on the event. See the complete API reference here. This link includes tips on idempotency and error handling.