---
title: "Webhook"
description: "An endpoint the account's events are delivered to"
canonical: "https://docs.printags.com/schemas/webhook/"
last_updated: "2026-11-16"
---

# Webhook

An endpoint the account's events are delivered to

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string (uuid) | no |  |
| `endpoint` | string (uri) | no |  |
| `description` | string, nullable | no |  |
| `webhook_events` | array of object | no | The events it is subscribed to |
| `webhook_events[].id` | string (uuid) | no |  |
| `webhook_events[].name` | string | no |  |
| `health` | object | no | Deliveries per state (in the list only) |
| `health.total` | integer | no |  |
| `health.succeeded` | integer | no |  |
| `health.failed` | integer | no |  |
| `health.pending` | integer | no |  |
| `health.lastAt` | string (date-time), nullable | no |  |
| `createdAt` | string (date-time) | no |  |
| `updatedAt` | string (date-time) | no |  |

## Example

```json
{
  "id": "3c0e8f8a-0000-4000-8000-000000000001",
  "endpoint": "https://boutique.example/wp-json/printags/v1/webhook",
  "description": "WooCommerce",
  "webhook_events": [
    {
      "name": "order.shipped"
    }
  ]
}
```
