Interactive API Documentation
Description: Creates a new job for immediate or scheduled execution
{
"event": "user_signup",
"type": "once",
"request": {
"url": "https://webhook.site/endpoint",
"method": "POST",
"headers": {
"Authorization": "Bearer token"
},
"payload": {
"message": "Hello {{user.name}}!",
"timestamp": "{{$timestamp}}"
},
"use_sources": true,
"sources": {
"user": {
"collection": "users",
"match": {"name": "John"},
"fields": ["name", "email"],
"single": true
}
}
}
}
Description: Retrieve a list of jobs with optional filtering, sorting, and pagination
status - Filter by status (pending, running, finished)event - Filter by event namesort_by - Sort field (created_at, status, event)sort_order - Sort direction (asc, desc)page - Page number (default: 1)limit - Items per page (default: 10, max: 100)Description: Retrieve detailed information about a specific job
id - Job ID (required)Description: Cancel a pending or running job
id - Job ID (required)Description: Test request configuration without creating a job
{
"request": {
"url": "https://webhook.site/endpoint",
"method": "POST",
"payload": {
"user": "{{user}}",
"timestamp": "{{$timestamp}}"
},
"use_sources": true,
"sources": {
"user": {
"collection": "users",
"match": {"name": "John"},
"fields": ["name", "email"],
"single": true
}
}
}
}