Webhooks
Trigger a sandbox webhook
Advances a sandbox entity to its next state and delivers the matching webhook. Sandbox only.
POST
/
v1
/
webhooks
/
trigger
Trigger a sandbox webhook
curl --request POST \
--url https://api.theguarantors.com/v1/webhooks/trigger \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"event_type": "application.status.approved",
"application_id": "sd_3k29dls92jf83kdl",
"bond_id": "bond_7f29djw82kdpq9sl",
"invite_id": "inv_01HQ8X",
"invite_recipient_id": "ivre_q7ghmgtaavp37krc"
}
'import requests
url = "https://api.theguarantors.com/v1/webhooks/trigger"
payload = {
"event_type": "application.status.approved",
"application_id": "sd_3k29dls92jf83kdl",
"bond_id": "bond_7f29djw82kdpq9sl",
"invite_id": "inv_01HQ8X",
"invite_recipient_id": "ivre_q7ghmgtaavp37krc"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
event_type: 'application.status.approved',
application_id: 'sd_3k29dls92jf83kdl',
bond_id: 'bond_7f29djw82kdpq9sl',
invite_id: 'inv_01HQ8X',
invite_recipient_id: 'ivre_q7ghmgtaavp37krc'
})
};
fetch('https://api.theguarantors.com/v1/webhooks/trigger', 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.theguarantors.com/v1/webhooks/trigger",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'event_type' => 'application.status.approved',
'application_id' => 'sd_3k29dls92jf83kdl',
'bond_id' => 'bond_7f29djw82kdpq9sl',
'invite_id' => 'inv_01HQ8X',
'invite_recipient_id' => 'ivre_q7ghmgtaavp37krc'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.theguarantors.com/v1/webhooks/trigger"
payload := strings.NewReader("{\n \"event_type\": \"application.status.approved\",\n \"application_id\": \"sd_3k29dls92jf83kdl\",\n \"bond_id\": \"bond_7f29djw82kdpq9sl\",\n \"invite_id\": \"inv_01HQ8X\",\n \"invite_recipient_id\": \"ivre_q7ghmgtaavp37krc\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
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.theguarantors.com/v1/webhooks/trigger")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"event_type\": \"application.status.approved\",\n \"application_id\": \"sd_3k29dls92jf83kdl\",\n \"bond_id\": \"bond_7f29djw82kdpq9sl\",\n \"invite_id\": \"inv_01HQ8X\",\n \"invite_recipient_id\": \"ivre_q7ghmgtaavp37krc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.theguarantors.com/v1/webhooks/trigger")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"event_type\": \"application.status.approved\",\n \"application_id\": \"sd_3k29dls92jf83kdl\",\n \"bond_id\": \"bond_7f29djw82kdpq9sl\",\n \"invite_id\": \"inv_01HQ8X\",\n \"invite_recipient_id\": \"ivre_q7ghmgtaavp37krc\"\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"event_id": "9b1e4c7a-2d3f-4e8b-a6c5-0f7d2e9a1b84",
"event_type": "bond.status.issued",
"occurred_at": "2026-08-28T16:41:19Z"
}{
"message": "invalid request body",
"object": "error"
}{
"message": "Missing authorization header",
"object": "error"
}{
"message": "entity not found",
"object": "error"
}{
"message": "resource cannot be modified in its current state",
"object": "error"
}{
"message": "event type not implemented",
"object": "error"
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Event to trigger
Available options:
application.status.started, application.status.submitted, application.status.pending, application.status.approved, application.status.denied, applicant.status.started, applicant.status.submitted, bond.status.issued, bond.status.canceled Example:
"application.status.approved"
Example:
"sd_3k29dls92jf83kdl"
Example:
"bond_7f29djw82kdpq9sl"
Example:
"inv_01HQ8X"
Example:
"ivre_q7ghmgtaavp37krc"
Response
OK
Example:
"9b1e4c7a-2d3f-4e8b-a6c5-0f7d2e9a1b84"
Available options:
invite.status.canceled, invite.updated, invite_recipient.removed, invite_recipient.added, invite_recipient.updated, applicant.status.started, applicant.status.submitted, application.status.started, application.status.submitted, application.status.approved, application.status.denied, application.status.pending, application.status.canceled, bond.status.issued, bond.status.canceled Example:
"bond.status.issued"
Example:
"2026-08-28T16:41:19Z"
⌘I
Trigger a sandbox webhook
curl --request POST \
--url https://api.theguarantors.com/v1/webhooks/trigger \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"event_type": "application.status.approved",
"application_id": "sd_3k29dls92jf83kdl",
"bond_id": "bond_7f29djw82kdpq9sl",
"invite_id": "inv_01HQ8X",
"invite_recipient_id": "ivre_q7ghmgtaavp37krc"
}
'import requests
url = "https://api.theguarantors.com/v1/webhooks/trigger"
payload = {
"event_type": "application.status.approved",
"application_id": "sd_3k29dls92jf83kdl",
"bond_id": "bond_7f29djw82kdpq9sl",
"invite_id": "inv_01HQ8X",
"invite_recipient_id": "ivre_q7ghmgtaavp37krc"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
event_type: 'application.status.approved',
application_id: 'sd_3k29dls92jf83kdl',
bond_id: 'bond_7f29djw82kdpq9sl',
invite_id: 'inv_01HQ8X',
invite_recipient_id: 'ivre_q7ghmgtaavp37krc'
})
};
fetch('https://api.theguarantors.com/v1/webhooks/trigger', 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.theguarantors.com/v1/webhooks/trigger",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'event_type' => 'application.status.approved',
'application_id' => 'sd_3k29dls92jf83kdl',
'bond_id' => 'bond_7f29djw82kdpq9sl',
'invite_id' => 'inv_01HQ8X',
'invite_recipient_id' => 'ivre_q7ghmgtaavp37krc'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.theguarantors.com/v1/webhooks/trigger"
payload := strings.NewReader("{\n \"event_type\": \"application.status.approved\",\n \"application_id\": \"sd_3k29dls92jf83kdl\",\n \"bond_id\": \"bond_7f29djw82kdpq9sl\",\n \"invite_id\": \"inv_01HQ8X\",\n \"invite_recipient_id\": \"ivre_q7ghmgtaavp37krc\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
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.theguarantors.com/v1/webhooks/trigger")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"event_type\": \"application.status.approved\",\n \"application_id\": \"sd_3k29dls92jf83kdl\",\n \"bond_id\": \"bond_7f29djw82kdpq9sl\",\n \"invite_id\": \"inv_01HQ8X\",\n \"invite_recipient_id\": \"ivre_q7ghmgtaavp37krc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.theguarantors.com/v1/webhooks/trigger")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"event_type\": \"application.status.approved\",\n \"application_id\": \"sd_3k29dls92jf83kdl\",\n \"bond_id\": \"bond_7f29djw82kdpq9sl\",\n \"invite_id\": \"inv_01HQ8X\",\n \"invite_recipient_id\": \"ivre_q7ghmgtaavp37krc\"\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"event_id": "9b1e4c7a-2d3f-4e8b-a6c5-0f7d2e9a1b84",
"event_type": "bond.status.issued",
"occurred_at": "2026-08-28T16:41:19Z"
}{
"message": "invalid request body",
"object": "error"
}{
"message": "Missing authorization header",
"object": "error"
}{
"message": "entity not found",
"object": "error"
}{
"message": "resource cannot be modified in its current state",
"object": "error"
}{
"message": "event type not implemented",
"object": "error"
}