API Reference
  1. Viv Public API
  2. Webhooks

Create webhook

post
https://{apiHost}/api/v2/public/webhooks

Create a new webhook subscription. Viv will send HTTP POST requests
to your URL when subscribed events occur.

Available Events:

CategoryEvents
Clientsclient.created, client.updated, client.status_changed
Caregiverscaregiver.created, caregiver.updated, caregiver.terminated
Visitsvisit.created, visit.updated, visit.confirmed, visit.cancelled
EVVevv.check_in, evv.check_out
Leadslead.created, lead.updated, lead.converted, lead.closed
Referrersreferrer.created, referrer.updated
Referrer OrganizationsreferrerOrganization.created, referrerOrganization.updated
Authorizationsauthorization.created, authorization.updated, authorization.expiring, authorization.exhausted
Taskstask.created, task.assigned, task.completed
Notesnote.created, note.updated
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Webhook name for identification

uri
required

URL to receive webhook payloads (must be HTTPS)

events
array of strings
required

Event types to subscribe to. Examples:

  • client.created, client.updated, client.status_changed
  • caregiver.created, caregiver.updated, caregiver.terminated
  • visit.created, visit.updated, visit.confirmed, visit.cancelled
  • evv.check_in, evv.check_out
events*
headers
object

Custom headers to include in webhook requests

string
enum
Defaults to active
Allowed:
Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?