When important changes happen — like new requests or status updates — PeopleCheck sends notifications to a web address you choose, so you don’t need to keep checking the system manually.

​
Creating your webhook

1

Log in to your account

Sign in to your PeopleCheck account.
2

Open Integrations

Navigate to the Integrations section and select Webhooks from the menu.
3

Configure the webhook

Create a new webhook and fill in the fields below.
  • Events: Select the events the webhook will listen to. These events act as triggers to send requests to your endpoint.
  • Label: A name that helps you identify the webhook’s purpose, such as “Status updates” or “Package notifications”.
  • URL: The endpoint where you want to receive the webhook requests. Make sure the URL is correctly formatted, publicly reachable, and served over HTTPS.
  • Token: An optional authentication key. When set, it is sent with each request as an Authorization Bearer token so your server can verify the notification.
4

Save

Click Create new webhook to activate it.

​
Using the webhook token

If you configured a token, it is included in the Authorization header of every request sent to your endpoint. Implement validation logic on your server to verify the authenticity of each incoming request using this token.
Authorization header
Your endpoint should respond with a 2xx status code to acknowledge receipt. If it doesn’t, the delivery is treated as failed.

​
Testing the connection

After completing the setup, test your endpoint to make sure you’re receiving data correctly. Select Test connection to send a placeholder test payload to your URL.

​
Understanding the feedback

  • Connecting: Attempting to reach the webhook endpoint.
  • Success: The endpoint was reached and received the test data.
  • Error: An issue occurred during the connection.
  • Disconnected: Access to this webhook has been revoked.

​
Security reminders

  • Use HTTPS: Make sure your webhook URL uses HTTPS to keep data secure in transit.
  • Keep your token secret: Don’t share it publicly or expose it in your code repositories.
  • Rotate tokens regularly: Rotate your token periodically and update your validation logic accordingly.
Not sure which events to subscribe to? Review the event types to decide which changes matter most to your workflow.