Skip to main content

Webhooks Introduction

Prerequisites Required

Before diving into webhooks, make sure you have:

  1. Dashboard Access: You need access to deepsy.fr/dashboard
  2. Company Membership: You must be a member of at least one company

What are Webhooks?​

Think of webhooks as notifications for your application. When something important happens in DeePsy like a candidate finishing an assessment or an email being delivered - we'll send an HTTP POST request to a URL you specify with all the relevant details.

Why Use Webhooks?​

Real-time Updates​

Get instant notifications when events occur. No more constantly polling our API to check for changes.

Seamless integration​

Easily synchronise DeePsy data with your internal systems and third-party tools.

Better User Experience​

Build responsive applications that react immediately to candidate progress, campaign updates, and email delivery status.

Reliable Delivery​

Our webhook system includes automatic retries and comprehensive logging to ensure you never miss important events.

How It Works​

The webhook flow is straightforward:

1. Event Happens

  • Something occurs in DeePsy (candidate completes test, email bounces, etc.)

2. Webhook Triggered

  • DeePsy identifies which webhooks is associated with the company, we then check if the webhooks have the proper authorization and events enabled

3. HTTP Request sent

  • We send a POST request to your webhook URL with the event data

4. Your App Responds

  • Your endpoint processes the event and returns a response

5. Delivery Logged

  • DeePsy records the successful delivery, or logs the failure with the status code and a truncated part of the response message for monitoring

Available Events​

At the current moment, DeePsy supports webhooks for 16 different event types across 4 categories:

Email Events (6 events)​

  • Email sent, delivered, bounced, dropped, opened, clicked

Campaign Events (3 events)​

  • Campaign created, updated, archived

Candidate Events (5 events)​

  • Candidate created, questionnaire completed, test started/completed, evaluation completed

User Events (2 events)​

  • User created, user invited

For detailed information about each event and their payloads, see our Events Guide.

Security & Authorization​

Company-based Access​

Webhooks are tied to specific companies. You can only create webhooks for companies you belong to, and only administrators can authorize them.

HTTPS Required​

All webhook URLs must use HTTPS to ensure secure data transmission. We might enforce HTTPS in the future, but for now it's not required.

Signature Verification​

Webhook payloads can be cryptographically (HMAC) signed to verify they come from DeePsy, similar to how other popular webhook services like GitHub does.

Learn more in our Security Guide.

Getting Started​

Ready to set up your first webhook? You'll need:

  1. Dashboard Access: Make sure you can access deepsy.fr/dashboard
  2. Administrator Permissions: You need admin rights for the companies you want to monitor
  3. Webhook Endpoint: A publicly accessible HTTPS URL that can receive POST requests

Continue to our Setup Guide to create your first webhook.

Need Help?​

If you run into any issues: