Fire Webhook Trigger
curl --request POST \
--url https://api.example.com/external/v1/automations/webhooks/{public_id}/fire/import requests
url = "https://api.example.com/external/v1/automations/webhooks/{public_id}/fire/"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/external/v1/automations/webhooks/{public_id}/fire/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/external/v1/automations/webhooks/{public_id}/fire/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/external/v1/automations/webhooks/{public_id}/fire/"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/external/v1/automations/webhooks/{public_id}/fire/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/external/v1/automations/webhooks/{public_id}/fire/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyFire Webhook Trigger
Trigger an automation via its webhook endpoint
POST
/
external
/
v1
/
automations
/
webhooks
/
{public_id}
/
fire
/
Fire Webhook Trigger
curl --request POST \
--url https://api.example.com/external/v1/automations/webhooks/{public_id}/fire/import requests
url = "https://api.example.com/external/v1/automations/webhooks/{public_id}/fire/"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/external/v1/automations/webhooks/{public_id}/fire/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/external/v1/automations/webhooks/{public_id}/fire/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/external/v1/automations/webhooks/{public_id}/fire/"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/external/v1/automations/webhooks/{public_id}/fire/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/external/v1/automations/webhooks/{public_id}/fire/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyFire Webhook Trigger
Trigger an automation via webhook. The webhook payload will be mapped to application/candidate fields based on the trigger’s field mapping configuration.Endpoints
POST /external/v1/automations/webhooks/{public_id}/fire/
GET /external/v1/automations/webhooks/{public_id}/fire/
Authentication
[!NOTE]
This endpoint is authenticated via the unique webhook URL (public_id) and does not require an API key.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
public_id | string (UUID) | Yes | The webhook trigger’s public ID |
Request Body (POST)
The request body structure depends on the field mapping configuration of the webhook trigger.{
"candidate": {
"email": "john@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "+1234567890",
"id": "ext_12345"
},
"flow_id": "hiring_flow_uuid",
"custom_fields": {
"years_experience": "5"
}
}
Example Request
curl -X POST "https://api.firstwork.com/external/v1/automations/webhooks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/fire/" \
-H "Content-Type: application/json" \
-d '{
"candidate": {
"email": "john@example.com",
"first_name": "John",
"last_name": "Doe"
},
"flow_id": "hiring-flow-uuid"
}'
Responses
202: Accepted
Webhook received and queued for async processing.400: Bad Request
Automation inactive, empty payload, or validation error.404: Not Found
Webhook trigger not found.409: Conflict
Idempotency conflict during concurrent request processing.429: Too Many Requests
Rate limit exceeded.503: Service Unavailable
Service temporarily unavailable (rate limiting infrastructure down).Notes
- The automation executes asynchronously — the response confirms the trigger was received
- Both GET and POST methods are supported
- The webhook payload fields should match the automation’s field mapping configuration