Vouch Webhooks enable callbacks to be made to Enterprise customer's HTTP(S) endpoints when specific events have been triggered (often referred to as notifications).
The following document outlines the expected payload for these Webhooks relating to the Vouch Request function within the Platform.
vouch.created
Event is generated whenever a new Vouch is created via the REST API or Admin User Interface.
"event" : {
"name" : "vouch.created",
"timestamp" : "2021-07-06T10:08:08.683Z",
"vouch" : {
"id" : "vvvvvvvvvv",
"status" : "DRAFT"
},
"campaign" : {
"id" : "cccccccccc",
"name" : "Happy Customers"
},
"entity" : {
"id" : "eeeeeeeeee",
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"account" : {
"name" : "Person",
"email" : "[email protected]"
},
"customer" : {
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"contact" : {
"name" : "Person",
"email" : "[email protected]"
}
}vouch.deleted
Event is generated whenever a new Vouch is deleted via the REST API or Admin User Interface.
"event" : {
"name" : "vouch.deleted",
"timestamp" : "2021-07-06T10:08:08.683Z",
"vouch" : {
"id" : "vvvvvvvvvv",
"status" : "DRAFT | SENT | PUBLISHED | VIEWED | RESPONDED"
},
"campaign" : {
"id" : "cccccccccc",
"name" : "Happy Customers"
},
"entity" : {
"id" : "eeeeeeeeee",
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"account" : {
"name" : "Person",
"email" : "[email protected]"
},
"customer" : {
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"contact" : {
"name" : "Person",
"email" : "[email protected]"
}
}vouch.sent
Event is generated whenever a new Vouch is sent via the Admin User Interface.
"event" : {
"name" : "vouch.sent",
"timestamp" : "2021-07-06T10:08:08.683Z",
"vouch" : {
"id" : "vvvvvvvvvv",
"status" : "SENT",
"url" : "https://app.vouchfor.com/request/vvvvvvvvvv"
},
"campaign" : {
"id" : "cccccccccc",
"name" : "Happy Customers"
},
"entity" : {
"id" : "eeeeeeeeee",
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"account" : {
"name" : "Person",
"email" : "[email protected]"
},
"customer" : {
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"contact" : {
"name" : "Person",
"email" : "[email protected]"
}
}vouch.published
Event is generated whenever a new Vouch is published via the REST API or Admin User Interface.
Note: A Vouch is automatically set as published when created via the REST API.
"event" : {
"name" : "vouch.published",
"timestamp" : "2021-07-06T10:08:08.683Z",
"vouch" : {
"id" : "vvvvvvvvvv",
"status" : "PUBLISHED",
"url" : "https://app.vouchfor.com/request/vvvvvvvvvv"
},
"campaign" : {
"id" : "cccccccccc",
"name" : "Happy Customers"
},
"entity" : {
"id" : "eeeeeeeeee",
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"account" : {
"name" : "Person",
"email" : "[email protected]"
},
"customer" : {
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"contact" : {
"name" : "Person",
"email" : "[email protected]"
}
}vouch.viewed
Event is generated whenever a published / sent Vouch is viewed by the responder.
"event" : {
"name" : "vouch.viewed",
"timestamp" : "2021-07-06T10:08:08.683Z",
"vouch" : {
"id" : "vvvvvvvvvv",
"status" : "VIEWED",
"url" : "https://app.vouchfor.com/request/vvvvvvvvvv"
},
"campaign" : {
"id" : "cccccccccc",
"name" : "Happy Customers"
},
"entity" : {
"id" : "eeeeeeeeee",
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"account" : {
"name" : "Person",
"email" : "[email protected]"
},
"customer" : {
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"contact" : {
"name" : "Person",
"email" : "[email protected]"
}
}vouch.reminded
Event is generated whenever a reminder is sent from the Admin User Interface.
"event" : {
"name" : "vouch.reminded",
"timestamp" : "2021-07-06T10:08:08.683Z",
"vouch" : {
"id" : "vvvvvvvvvv",
"status" : "SENT | PUBLISHED | VIEWED | SCHEDULED",
"url" : "https://app.vouchfor.com/request/vvvvvvvvvv"
},
"campaign" : {
"id" : "cccccccccc",
"name" : "Happy Customers"
},
"entity" : {
"id" : "eeeeeeeeee",
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"account" : {
"name" : "Person",
"email" : "[email protected]"
},
"customer" : {
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"contact" : {
"name" : "Person",
"email" : "[email protected]"
}
}vouch.declined
Event is generated whenever a Vouch has been declined by the responder.
"event" : {
"name" : "vouch.declined",
"timestamp" : "2021-07-06T10:08:08.683Z",
"vouch" : {
"id" : "vvvvvvvvvv",
"status" : "DECLINED",
"url" : "https://app.vouchfor.com/request/vvvvvvvvvv"
},
"campaign" : {
"id" : "cccccccccc",
"name" : "Happy Customers"
},
"entity" : {
"id" : "eeeeeeeeee",
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"account" : {
"name" : "Person",
"email" : "[email protected]"
},
"customer" : {
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"contact" : {
"name" : "Person",
"email" : "[email protected]"
},
"message" : {
"text" : "this is why I declined"
}
}vouch.scheduled
Event is generated whenever a responder elects to complete a Vouch at a later date.
"event" : {
"name" : "vouch.scheduled",
"timestamp" : "2021-07-06T10:08:08.683Z",
"vouch" : {
"id" : "vvvvvvvvvv",
"status" : "SCHEDULED",
"url" : "https://app.vouchfor.com/request/vvvvvvvvvv"
},
"campaign" : {
"id" : "cccccccccc",
"name" : "Happy Customers"
},
"entity" : {
"id" : "eeeeeeeeee",
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"account" : {
"name" : "Person",
"email" : "[email protected]"
},
"customer" : {
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"contact" : {
"name" : "Person",
"email" : "[email protected]"
}
}vouch.submitted
Event is generated whenever a responder submits a completed Vouch.
Note: The URL provided in the Webhook changes from the Request link to the Play Link. A submitted Vouch still needs to be transcoded and transcribed until it is ready to view.
"event" : {
"name" : "vouch.submitted",
"timestamp" : "2021-07-06T10:08:08.683Z",
"vouch" : {
"id" : "vvvvvvvvvv",
"status" : "SUBMITTED",
"url" : "https://app.vouchfor.com/vvvvvvvvvv"
},
"campaign" : {
"id" : "cccccccccc",
"name" : "Happy Customers"
},
"entity" : {
"id" : "eeeeeeeeee",
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"account" : {
"name" : "Person",
"email" : "[email protected]"
},
"customer" : {
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"contact" : {
"name" : "Person",
"email" : "[email protected]"
}
}vouch.responded
Event is generated once the transcoding and transcription functions have been completed on a submitted Vouch.
"event" : {
"name" : "vouch.responded",
"timestamp" : "2021-07-06T10:08:08.683Z",
"vouch" : {
"id" : "vvvvvvvvvv",
"status" : "RESPONDED",
"url" : "https://app.vouchfor.com/vvvvvvvvvv",
"plays" : 0
},
"campaign" : {
"id" : "cccccccccc",
"name" : "Happy Customers"
},
"entity" : {
"id" : "eeeeeeeeee",
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"account" : {
"name" : "Person",
"email" : "[email protected]"
},
"customer" : {
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"contact" : {
"name" : "Person",
"email" : "[email protected]"
}
}vouch.message
Event is generated whenever a responder submits a message post the Vouch Submitted step.
"event" : {
"name" : "vouch.declined",
"timestamp" : "2021-07-06T10:08:08.683Z",
"vouch" : {
"id" : "vvvvvvvvvv",
"status" : "SUBMITTED | RESPONDED",
"url" : "https://app.vouchfor.com/vvvvvvvvvv",
"plays" : 0
},
"campaign" : {
"id" : "cccccccccc",
"name" : "Happy Customers"
},
"entity" : {
"id" : "eeeeeeeeee",
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"account" : {
"name" : "Person",
"email" : "[email protected]"
},
"customer" : {
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"contact" : {
"name" : "Person",
"email" : "[email protected]"
},
"message" : {
"text" : "this is a message from the contact"
}
}vouch.shared
Event is generated whenever the Vouch Play Link URL is copied within the Vouch Admin User Interface.
"event" : {
"name" : "vouch.shared",
"timestamp" : "2021-07-06T10:08:08.683Z",
"vouch" : {
"id" : "vvvvvvvvvv",
"status" : "RESPONDED",
"url" : "https://app.vouchfor.com/vvvvvvvvvv",
"plays" : 1
},
"campaign" : {
"id" : "cccccccccc",
"name" : "Happy Customers"
},
"entity" : {
"id" : "eeeeeeeeee",
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"account" : {
"name" : "Person",
"email" : "[email protected]"
},
"customer" : {
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"contact" : {
"name" : "Person",
"email" : "[email protected]"
}
}vouch.watched
Event is generated whenever a Vouch is watched, either via the Play Link or a Web Embed.
"event" : {
"name" : "vouch.watched",
"timestamp" : "2021-07-06T10:08:08.683Z",
"vouch" : {
"id" : "vvvvvvvvvv",
"status" : "RESPONDED",
"url" : "https://app.vouchfor.com/vvvvvvvvvv",
"plays" : 1
},
"campaign" : {
"id" : "cccccccccc",
"name" : "Happy Customers"
},
"entity" : {
"id" : "eeeeeeeeee",
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"account" : {
"name" : "Person",
"email" : "[email protected]"
},
"customer" : {
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"contact" : {
"name" : "Person",
"email" : "[email protected]"
}
}vouch.updated
Event is generated whenever a Vouch has been modified. Modifications may include changing the order of questions, trimming the video and/or updating the transcriptions.
"event" : {
"name" : "vouch.updated",
"timestamp" : "2021-07-06T10:08:08.683Z",
"vouch" : {
"id" : "vvvvvvvvvv",
"status" : "RESPONDED",
"url" : "https://app.vouchfor.com/vvvvvvvvvv",
"plays" : 1
},
"campaign" : {
"id" : "cccccccccc",
"name" : "Happy Customers"
},
"entity" : {
"id" : "eeeeeeeeee",
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"account" : {
"name" : "Person",
"email" : "[email protected]"
},
"customer" : {
"name" : "Vouch",
"url" : "https://vouchfor.com"
},
"contact" : {
"name" : "Person",
"email" : "[email protected]"
}
}