Create a Webhook
curl --request POST \
--url https://api.virtuoussoftware.com/api/Webhook \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payloadUrl": "<string>",
"secret": "<string>",
"contactCreate": "<boolean>",
"contactUpdate": "<boolean>",
"giftCreate": "<boolean>",
"giftUpdate": "<boolean>",
"giftDelete": "<boolean>",
"projectCreate": "<boolean>",
"projectUpdate": "<boolean>",
"projectDelete": "<boolean>",
"formSubmission": "<boolean>",
"contactNoteCreate": "<boolean>",
"contactNoteUpdate": "<boolean>",
"contactNoteDelete": "<boolean>",
"eventCreate": "<boolean>",
"eventUpdate": "<boolean>",
"eventDelete": "<boolean>",
"active": "<boolean>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payloadUrl: '<string>',
secret: '<string>',
contactCreate: '<boolean>',
contactUpdate: '<boolean>',
giftCreate: '<boolean>',
giftUpdate: '<boolean>',
giftDelete: '<boolean>',
projectCreate: '<boolean>',
projectUpdate: '<boolean>',
projectDelete: '<boolean>',
formSubmission: '<boolean>',
contactNoteCreate: '<boolean>',
contactNoteUpdate: '<boolean>',
contactNoteDelete: '<boolean>',
eventCreate: '<boolean>',
eventUpdate: '<boolean>',
eventDelete: '<boolean>',
active: '<boolean>'
})
};
fetch('https://api.virtuoussoftware.com/api/Webhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/Webhook"
payload = {
"payloadUrl": "<string>",
"secret": "<string>",
"contactCreate": "<boolean>",
"contactUpdate": "<boolean>",
"giftCreate": "<boolean>",
"giftUpdate": "<boolean>",
"giftDelete": "<boolean>",
"projectCreate": "<boolean>",
"projectUpdate": "<boolean>",
"projectDelete": "<boolean>",
"formSubmission": "<boolean>",
"contactNoteCreate": "<boolean>",
"contactNoteUpdate": "<boolean>",
"contactNoteDelete": "<boolean>",
"eventCreate": "<boolean>",
"eventUpdate": "<boolean>",
"eventDelete": "<boolean>",
"active": "<boolean>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/Webhook");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"payloadUrl\": \"<string>\",\n \"secret\": \"<string>\",\n \"contactCreate\": \"<boolean>\",\n \"contactUpdate\": \"<boolean>\",\n \"giftCreate\": \"<boolean>\",\n \"giftUpdate\": \"<boolean>\",\n \"giftDelete\": \"<boolean>\",\n \"projectCreate\": \"<boolean>\",\n \"projectUpdate\": \"<boolean>\",\n \"projectDelete\": \"<boolean>\",\n \"formSubmission\": \"<boolean>\",\n \"contactNoteCreate\": \"<boolean>\",\n \"contactNoteUpdate\": \"<boolean>\",\n \"contactNoteDelete\": \"<boolean>\",\n \"eventCreate\": \"<boolean>\",\n \"eventUpdate\": \"<boolean>\",\n \"eventDelete\": \"<boolean>\",\n \"active\": \"<boolean>\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/Webhook",
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([
'payloadUrl' => '<string>',
'secret' => '<string>',
'contactCreate' => '<boolean>',
'contactUpdate' => '<boolean>',
'giftCreate' => '<boolean>',
'giftUpdate' => '<boolean>',
'giftDelete' => '<boolean>',
'projectCreate' => '<boolean>',
'projectUpdate' => '<boolean>',
'projectDelete' => '<boolean>',
'formSubmission' => '<boolean>',
'contactNoteCreate' => '<boolean>',
'contactNoteUpdate' => '<boolean>',
'contactNoteDelete' => '<boolean>',
'eventCreate' => '<boolean>',
'eventUpdate' => '<boolean>',
'eventDelete' => '<boolean>',
'active' => '<boolean>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.virtuoussoftware.com/api/Webhook")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payloadUrl\": \"<string>\",\n \"secret\": \"<string>\",\n \"contactCreate\": \"<boolean>\",\n \"contactUpdate\": \"<boolean>\",\n \"giftCreate\": \"<boolean>\",\n \"giftUpdate\": \"<boolean>\",\n \"giftDelete\": \"<boolean>\",\n \"projectCreate\": \"<boolean>\",\n \"projectUpdate\": \"<boolean>\",\n \"projectDelete\": \"<boolean>\",\n \"formSubmission\": \"<boolean>\",\n \"contactNoteCreate\": \"<boolean>\",\n \"contactNoteUpdate\": \"<boolean>\",\n \"contactNoteDelete\": \"<boolean>\",\n \"eventCreate\": \"<boolean>\",\n \"eventUpdate\": \"<boolean>\",\n \"eventDelete\": \"<boolean>\",\n \"active\": \"<boolean>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/Webhook")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payloadUrl\": \"<string>\",\n \"secret\": \"<string>\",\n \"contactCreate\": \"<boolean>\",\n \"contactUpdate\": \"<boolean>\",\n \"giftCreate\": \"<boolean>\",\n \"giftUpdate\": \"<boolean>\",\n \"giftDelete\": \"<boolean>\",\n \"projectCreate\": \"<boolean>\",\n \"projectUpdate\": \"<boolean>\",\n \"projectDelete\": \"<boolean>\",\n \"formSubmission\": \"<boolean>\",\n \"contactNoteCreate\": \"<boolean>\",\n \"contactNoteUpdate\": \"<boolean>\",\n \"contactNoteDelete\": \"<boolean>\",\n \"eventCreate\": \"<boolean>\",\n \"eventUpdate\": \"<boolean>\",\n \"eventDelete\": \"<boolean>\",\n \"active\": \"<boolean>\"\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/Webhook';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payloadUrl: '<string>',
secret: '<string>',
contactCreate: '<boolean>',
contactUpdate: '<boolean>',
giftCreate: '<boolean>',
giftUpdate: '<boolean>',
giftDelete: '<boolean>',
projectCreate: '<boolean>',
projectUpdate: '<boolean>',
projectDelete: '<boolean>',
formSubmission: '<boolean>',
contactNoteCreate: '<boolean>',
contactNoteUpdate: '<boolean>',
contactNoteDelete: '<boolean>',
eventCreate: '<boolean>',
eventUpdate: '<boolean>',
eventDelete: '<boolean>',
active: '<boolean>'
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 9500,
"payloadUrl": "https://example.org/webhooks/virtuous",
"secret": "whsec_1a2b3c4d5e6f7g8h9i0j",
"contactCreate": true,
"contactUpdate": true,
"giftCreate": true,
"giftUpdate": true,
"giftDelete": false,
"projectCreate": false,
"projectUpdate": false,
"projectDelete": false,
"formSubmission": true,
"contactNoteCreate": false,
"contactNoteUpdate": false,
"contactNoteDelete": false,
"eventCreate": false,
"eventUpdate": false,
"eventDelete": false,
"active": true
}{
"message": "Authorization has been denied for this request."
}{
"message": "You do not have permission to perform this action."
}{
"message": "Rate limit exceeded. Try again later."
}Webhooks
Create a Webhook
Subscribes a payload URL to the events you select, so Virtuous notifies your system when records change instead of you polling for them. Set secret to a value you generate and use it to verify the signature on each delivery.
POST
/
api
/
Webhook
Create a Webhook
curl --request POST \
--url https://api.virtuoussoftware.com/api/Webhook \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payloadUrl": "<string>",
"secret": "<string>",
"contactCreate": "<boolean>",
"contactUpdate": "<boolean>",
"giftCreate": "<boolean>",
"giftUpdate": "<boolean>",
"giftDelete": "<boolean>",
"projectCreate": "<boolean>",
"projectUpdate": "<boolean>",
"projectDelete": "<boolean>",
"formSubmission": "<boolean>",
"contactNoteCreate": "<boolean>",
"contactNoteUpdate": "<boolean>",
"contactNoteDelete": "<boolean>",
"eventCreate": "<boolean>",
"eventUpdate": "<boolean>",
"eventDelete": "<boolean>",
"active": "<boolean>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payloadUrl: '<string>',
secret: '<string>',
contactCreate: '<boolean>',
contactUpdate: '<boolean>',
giftCreate: '<boolean>',
giftUpdate: '<boolean>',
giftDelete: '<boolean>',
projectCreate: '<boolean>',
projectUpdate: '<boolean>',
projectDelete: '<boolean>',
formSubmission: '<boolean>',
contactNoteCreate: '<boolean>',
contactNoteUpdate: '<boolean>',
contactNoteDelete: '<boolean>',
eventCreate: '<boolean>',
eventUpdate: '<boolean>',
eventDelete: '<boolean>',
active: '<boolean>'
})
};
fetch('https://api.virtuoussoftware.com/api/Webhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/Webhook"
payload = {
"payloadUrl": "<string>",
"secret": "<string>",
"contactCreate": "<boolean>",
"contactUpdate": "<boolean>",
"giftCreate": "<boolean>",
"giftUpdate": "<boolean>",
"giftDelete": "<boolean>",
"projectCreate": "<boolean>",
"projectUpdate": "<boolean>",
"projectDelete": "<boolean>",
"formSubmission": "<boolean>",
"contactNoteCreate": "<boolean>",
"contactNoteUpdate": "<boolean>",
"contactNoteDelete": "<boolean>",
"eventCreate": "<boolean>",
"eventUpdate": "<boolean>",
"eventDelete": "<boolean>",
"active": "<boolean>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/Webhook");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"payloadUrl\": \"<string>\",\n \"secret\": \"<string>\",\n \"contactCreate\": \"<boolean>\",\n \"contactUpdate\": \"<boolean>\",\n \"giftCreate\": \"<boolean>\",\n \"giftUpdate\": \"<boolean>\",\n \"giftDelete\": \"<boolean>\",\n \"projectCreate\": \"<boolean>\",\n \"projectUpdate\": \"<boolean>\",\n \"projectDelete\": \"<boolean>\",\n \"formSubmission\": \"<boolean>\",\n \"contactNoteCreate\": \"<boolean>\",\n \"contactNoteUpdate\": \"<boolean>\",\n \"contactNoteDelete\": \"<boolean>\",\n \"eventCreate\": \"<boolean>\",\n \"eventUpdate\": \"<boolean>\",\n \"eventDelete\": \"<boolean>\",\n \"active\": \"<boolean>\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/Webhook",
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([
'payloadUrl' => '<string>',
'secret' => '<string>',
'contactCreate' => '<boolean>',
'contactUpdate' => '<boolean>',
'giftCreate' => '<boolean>',
'giftUpdate' => '<boolean>',
'giftDelete' => '<boolean>',
'projectCreate' => '<boolean>',
'projectUpdate' => '<boolean>',
'projectDelete' => '<boolean>',
'formSubmission' => '<boolean>',
'contactNoteCreate' => '<boolean>',
'contactNoteUpdate' => '<boolean>',
'contactNoteDelete' => '<boolean>',
'eventCreate' => '<boolean>',
'eventUpdate' => '<boolean>',
'eventDelete' => '<boolean>',
'active' => '<boolean>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.virtuoussoftware.com/api/Webhook")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payloadUrl\": \"<string>\",\n \"secret\": \"<string>\",\n \"contactCreate\": \"<boolean>\",\n \"contactUpdate\": \"<boolean>\",\n \"giftCreate\": \"<boolean>\",\n \"giftUpdate\": \"<boolean>\",\n \"giftDelete\": \"<boolean>\",\n \"projectCreate\": \"<boolean>\",\n \"projectUpdate\": \"<boolean>\",\n \"projectDelete\": \"<boolean>\",\n \"formSubmission\": \"<boolean>\",\n \"contactNoteCreate\": \"<boolean>\",\n \"contactNoteUpdate\": \"<boolean>\",\n \"contactNoteDelete\": \"<boolean>\",\n \"eventCreate\": \"<boolean>\",\n \"eventUpdate\": \"<boolean>\",\n \"eventDelete\": \"<boolean>\",\n \"active\": \"<boolean>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/Webhook")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payloadUrl\": \"<string>\",\n \"secret\": \"<string>\",\n \"contactCreate\": \"<boolean>\",\n \"contactUpdate\": \"<boolean>\",\n \"giftCreate\": \"<boolean>\",\n \"giftUpdate\": \"<boolean>\",\n \"giftDelete\": \"<boolean>\",\n \"projectCreate\": \"<boolean>\",\n \"projectUpdate\": \"<boolean>\",\n \"projectDelete\": \"<boolean>\",\n \"formSubmission\": \"<boolean>\",\n \"contactNoteCreate\": \"<boolean>\",\n \"contactNoteUpdate\": \"<boolean>\",\n \"contactNoteDelete\": \"<boolean>\",\n \"eventCreate\": \"<boolean>\",\n \"eventUpdate\": \"<boolean>\",\n \"eventDelete\": \"<boolean>\",\n \"active\": \"<boolean>\"\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/Webhook';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payloadUrl: '<string>',
secret: '<string>',
contactCreate: '<boolean>',
contactUpdate: '<boolean>',
giftCreate: '<boolean>',
giftUpdate: '<boolean>',
giftDelete: '<boolean>',
projectCreate: '<boolean>',
projectUpdate: '<boolean>',
projectDelete: '<boolean>',
formSubmission: '<boolean>',
contactNoteCreate: '<boolean>',
contactNoteUpdate: '<boolean>',
contactNoteDelete: '<boolean>',
eventCreate: '<boolean>',
eventUpdate: '<boolean>',
eventDelete: '<boolean>',
active: '<boolean>'
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 9500,
"payloadUrl": "https://example.org/webhooks/virtuous",
"secret": "whsec_1a2b3c4d5e6f7g8h9i0j",
"contactCreate": true,
"contactUpdate": true,
"giftCreate": true,
"giftUpdate": true,
"giftDelete": false,
"projectCreate": false,
"projectUpdate": false,
"projectDelete": false,
"formSubmission": true,
"contactNoteCreate": false,
"contactNoteUpdate": false,
"contactNoteDelete": false,
"eventCreate": false,
"eventUpdate": false,
"eventDelete": false,
"active": true
}{
"message": "Authorization has been denied for this request."
}{
"message": "You do not have permission to perform this action."
}{
"message": "Rate limit exceeded. Try again later."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The HTTPS endpoint the webhook payload is posted to.
The shared secret used to sign the payload so that your endpoint can verify it came from Virtuous.
When true, the webhook is enabled and will receive events.
Response
OK
The unique identifier of the record in Virtuous.
Last modified on August 11, 2026
Was this page helpful?
⌘I