---
title: "shopVOX event delivered to your endpoint"
method: POST
path: "event"
tags: ["Webhooks"]
---

# shopVOX event delivered to your endpoint

`POST event` (webhook)

shopVOX POSTs this payload to each active webhook endpoint you configure in the app
(Account Settings -> Webhook Endpoints). Verify authenticity with `webhook_token`
against the Webhook key shown in Account Settings.

**Plan:** Webhooks require the **Paid API** add-on - delivery is skipped for accounts
without it.

**Supported events** (note the delete action is `destroyed`, not `deleted`, and sales
orders are emitted as `work_order:*`):

- `company:created`, `company:updated`, `company:destroyed`
- `invoice:created`, `invoice:updated`, `invoice:destroyed`
- `job:created`, `job:updated`, `job:destroyed`
- `job_step:changed`
- `quote:created`, `quote:updated`, `quote:destroyed`
- `work_order:created`, `work_order:updated`, `work_order:destroyed`

**Your response controls retries**

- `200` (or any other success) - acknowledged, done.
- `408`, `500`, `502`, `503`, `504` - shopVOX retries (up to 5 times).
- `410` - shopVOX removes (deactivates) the endpoint.
- `400`, `401`, `403`, `404`, `422` - treated as temporary; the endpoint is **not**
  deactivated and the payload is **not** retried.
- Any other 4xx/5xx code - shopVOX deactivates the endpoint; re-enable it after fixing.

## Payload

- WebhookPayload
  - `event_object` string, required: Object name, e.g. job, company, invoice.
  - `event_action` string, required: Action, e.g. created, updated, destroyed.
  - `timestamp` integer, required: Unix timestamp (seconds) when the payload was sent.
  - `webhook_token` string, required: Token to verify the payload came from shopVOX.
  - `event` object, required: The affected object. Some events add keys - e.g. `job_step:changed` also sends `job_id`, `changed_from`, `changed_to`; updates may include a `changes` map.
    - `id` string, uuid: Id of the affected object.
    - `name` string: Name/title of the affected object.
    - `job_id` string, uuid: `job_step:changed` only.
    - `changed_from` string: `job_step:changed` only.
    - `changed_to` string: `job_step:changed` only.

## Acknowledgement `200`

Acknowledged.

---

[API](https://skmtc.dev/shopvox/apis/shopvox-public-api.md) - [All operations](https://skmtc.dev/shopvox/apis/shopvox-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/shopvox/apis/shopvox-public-api/revisions/eb2f6524de94?raw)