Project-Wide Callbacks enable automated notifications to a specified URL when key actions occur to jobs (and batches) within your project. This is useful for integrating with external systems or triggering automated workflows whenever specific events are performed in the platform.

Supported callback types:

• Job events (On by default, no schema version)
• Job Batch events (Optional, schema version 2)

To configure project-wide callback settings:

1. Navigate to the Project Settings:
   1. Go to Project Settings > General > Project Settings in the platform’s interface.
2. Locate the Webhook Settings:
   1. Scroll to the Webhook Settings section where you’ll find options to set and manage the callback URL.
3. Enter the Callback URL:
   1. In the Callback URL field, specify the URL you want to receive the callbacks.
   2. This URL should be accessible by the platform and configured to handle POST requests, as each triggered event will send a payload to this URL.
4. Save Changes:
   1. After entering the URL, select Save Changes to apply your configuration.

For more information on the structure of callback URLs and the actions that trigger them, refer to Callbacks

Job Batch Events in Callbacks

The primary entity type used in callbacks is the job entity.
When submitting jobs, the first entity users interact with is the job batch.
By enabling job batch events, you can receive notifications when a job batch has been fully processed.

Enabling job batch events allows you to build more advanced, event-driven integrations with our system.

Check out the Job batch callbacks page for more information.