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 eventdatetime: Date and time of the webhook callresponse_status: HTTP status code returned by your endpointresponse_body: Response body from your endpointapplication: Reference to the related application
This resource is paginated. Use the
_next field to browse the complete history.Implementing an Endpoint
Best Practices
- Respond quickly: Your endpoint must respond in less than 30 seconds
- Return a 200 code: Even if processing is asynchronous
- Validate data: Verify authenticity and data structure
- Handle duplicates: The same event may be sent multiple times in case of failure
- 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