Webhooks

Webhooks

Webhooks allow Trimoji to send real-time notifications to your application as soon as an event occurs (test completion, campaign creation, etc.). This is the most efficient method for synchronizing your data without unnecessarily querying the API.

How it works: When an event occurs, Trimoji makes an HTTP POST request to a URL you have configured, including the corresponding data.

1. Webhook Configuration

Webhook management is done within your client interface: My Trimoji Account.

Configuration Steps:

  1. Enter your server's destination URL (e.g., https://your-site.com/api/webhook).
  2. Select the events you wish to listen to.
  3. Confirm the addition.
  4. Important: Once the webhook is created, Trimoji automatically generates a unique Secret (Token). You must retrieve this token to secure your endpoint.

2. Security and Authentication

For each delivery, Trimoji uses the generated secret to sign and authenticate the request. You must verify this information on your server-side to ensure the call originates from our services.

The token is transmitted in two ways in each call:

  • In the HTTP header: Authorization: YOUR_GENERATED_TOKEN
  • In the JSON body: { "_token": "YOUR_GENERATED_TOKEN", ... }

3. Payload Structure

All requests sent by Trimoji follow a standardized JSON format, allowing for quick action identification.

{
  "_token": "trimoji_generated_token",
  "_timestamp": "2026-02-11T16:00:00.000Z",
  "_event": "QUIZZ_COMPLETED",

  // Dynamic data based on the event
  "id": 12345,
  "data": { ... }
}

4. Available Events

You can subscribe to different types of actions based on your automation needs:

Tests & Assessments
  • QUIZZ_SENT
  • QUIZZ_COMPLETED
Candidates & Profiles
  • PROFILE_UPDATED
  • PROFILE_DELETED
  • PROFILE_RESTORED
Campaigns & Personi
  • CAMPAIGN_CREATED / UPDATED
  • PERSONI_CREATED
Security & Flows
  • AUTH_LOGIN
  • TRANSFER_INCOMING

5. Technical Specifications

  • User-Agent : Requests are sent with the identifier trimoji/1.0.0.
  • Expected Response : Your server must return a 200 OK code. In case of an error on your side, Trimoji will log the failure in your account's logs.
  • Format : The request body is always in JSON.
Top