Skip to main content

Introduction to Webhooks

Webhooks allow JobAffinity to notify your system in real-time during important events (new application, step change, etc.).

Available Events

Main webhook events include:
  • ProcessStepChange: Step change in an application process
  • Other events available (contact support for the complete list)

Configuration

To configure webhooks, contact Intuition-Software support: support@intuition-software.fr You will need to provide:
  • Your endpoint URL that will receive notifications
  • The events you want to subscribe to
  • Desired security methods (authentication, signature, etc.)

Webhook Call History

You can view the history of webhook calls made by JobAffinity.

Request

Response

Response Fields

  • event: Type of triggered event
  • datetime: Date and time of the webhook call
  • response_status: HTTP status code returned by your endpoint
  • response_body: Response body from your endpoint
  • application: Reference to the related application
This resource is paginated. Use the _next field to browse the complete history.

Implementing an Endpoint

Best Practices

  1. Respond quickly: Your endpoint must respond in less than 30 seconds
  2. Return a 200 code: Even if processing is asynchronous
  3. Validate data: Verify authenticity and data structure
  4. Handle duplicates: The same event may be sent multiple times in case of failure
  5. Log calls: Keep a record of received webhooks for debugging

Endpoint Example (Python/Flask)

Endpoint Example (Node.js/Express)

Monitoring

Use webhook history to:
  • Verify your endpoint responds correctly
  • Debug errors
  • Detect performance issues
  • Audit received events
If your endpoint regularly returns errors (5xx), webhook calls may be temporarily suspended. Monitor your history and fix issues quickly.

Version Management

Webhooks follow the same versioning principle as the REST API. In case of major changes to the webhook format, you will be notified in advance.