Webhooks Overview
VectorCare sends real-time service request updates to your systems via webhooks. Webhooks are the only way you can access service request data in Open API 2.0.
When an event occurs in VectorCare, we send an HTTP POST request to your registered endpoint with a JSON payload containing the event details.
How It Works
Section titled “How It Works”VectorCare Event → HTTP POST → Your Webhook Endpoint → Process & Respond 2xx- Something changes in VectorCare (new request, data update, status change)
- VectorCare sends a POST request to your registered webhook URL
- Your server processes the data and responds with a 2xx status code
- If we don’t receive a 2xx, we retry with exponential backoff
Implementation Requirements
Section titled “Implementation Requirements”- Create a publicly accessible HTTPS endpoint
- Allow inbound traffic from VectorCare’s IP addresses (see IP Allowlist below)
- Register your endpoint URL in the VectorCare dashboard
- Implement idempotency using the
event_idandservice_request_idfields - Return a 2xx status code to acknowledge receipt
Webhook Payload Fields
Section titled “Webhook Payload Fields”| Field | Type | Description |
|---|---|---|
event_id | string | Unique identifier for deduplication (chronologically sortable) |
event_timestamp | string | UTC timestamp when webhook was sent (ISO 8601) |
service_request_id | string | Unique identifier for the service request |
request_status | string | Simplified status: AVAILABLE, ASSIGNED, COMPLETED, or UNAVAILABLE |
action | string | The event that triggered this webhook |
data | object | Complete request details (null when status is UNAVAILABLE) |
Setting Up Your Webhook
Section titled “Setting Up Your Webhook”See Configuring Your Receiver Organization in the Getting Started guide.
Response Codes
Section titled “Response Codes”| Your Response | Meaning | VectorCare Action |
|---|---|---|
2xx | Success | Delivery complete |
4xx, 5xx, timeout | Failure | Retry with backoff |
Only 2xx responses are considered successful. All other responses trigger retries.
Retry Behavior
Section titled “Retry Behavior”VectorCare retries failed webhooks with exponential backoff:
| Attempt | Delay |
|---|---|
| 1st (initial) | Immediate |
| 2nd | ~8 seconds |
| 3rd (final) | ~64 seconds |
Retries are triggered when your endpoint:
- Returns a non-2xx response
- Times out (>10 seconds)
- Is unreachable
After 3 failed attempts, the webhook is marked as failed. You can manually redeliver failed webhooks from the VectorCare dashboard.
IP Allowlist
Section titled “IP Allowlist”VectorCare delivers webhooks from the following IP addresses. If your endpoint is behind a firewall, WAF, or cloud security group, you must allow inbound HTTPS (port 443) traffic from all of them:
13.56.93.19113.56.34.20244.235.183.15644.237.187.11044.238.226.2003.137.97.12252.14.5.453.143.153.56
This applies to any layer that filters traffic before it reaches your application, including:
- Cloud provider firewall rules (AWS Security Groups, GCP firewall rules, Azure NSGs)
- Web application firewalls (AWS WAF, Cloudflare, etc.)
- CDN or reverse proxy allow lists
- OS-level firewalls (iptables, ufw)
Quick Links
Section titled “Quick Links”- Payload Structure - Full event payload schema
- Request Status Values - Understanding status states
- Actions - Event types that trigger webhooks
- Verification - Validating webhook signatures
- Best Practices - Performance and reliability tips