# Webhook events reference

Every event Pozy can send to your endpoint, grouped by area, with when it fires and an example payload.

This page lists every event type you can subscribe to. It is generated from the same event catalog that Pozy uses to deliver webhooks, so it is always complete.

Every delivery has the same envelope. The event-specific fields sit next to the common ones:

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "event": "post.published",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "profiles": [{ "id": "66b2e19d8c3f5a7e9d0b1c2d", "externalId": "customer_123" }],
  "post": { "...": "event-specific fields" }
}
```

| Field | What it is |
| --- | --- |
| `id` | Unique event id. The same value arrives in the `X-Pozy-Event-Id` header. Use it to drop duplicates. |
| `event` | The event type, for example `post.published`. Also in `X-Pozy-Event`. |
| `timestamp` | When the event happened, in UTC (ISO 8601). |
| `profiles` | The profiles the event belongs to, with your `externalId` when you set one. Use it to route the event to the right customer. |
| `test` | `true` on test deliveries sent from the dashboard or the test endpoint. |

To receive events, [create an endpoint](https://pozy.ai/docs/webhooks) and pick the event types you want. An endpoint with no event filter receives everything. Verify each delivery with [the signature](https://pozy.ai/docs/webhooks/signatures), and see [Retries](https://pozy.ai/docs/webhooks/retries) for what happens when your endpoint is down.

> **Tip:**
> 
> Example payloads are built from the event schemas. Values are placeholders; field names and shapes are exact.

## Posts

| Event | When it fires |
| --- | --- |
| [`post.scheduled`](#post-scheduled) | Post scheduled. |
| [`post.published`](#post-published) | Post published. |
| [`post.failed`](#post-failed) | Post failed. |
| [`post.partial`](#post-partial) | Post partial. |
| [`post.cancelled`](#post-cancelled) | Post cancelled. |
| [`post.recycled`](#post-recycled) | Post recycled. |
| [`post.platform.published`](#post-platform-published) | Post platform published. |
| [`post.platform.failed`](#post-platform-failed) | Post platform failed. |
| [`post.platform.deleted`](#post-platform-deleted) | Post platform deleted. |
| [`post.tiktok.url_resolved`](#post-tiktok-url-resolved) | TikTok post URL resolved. |
| [`post.tracking_completed`](#post-tracking-completed) | Post tracking completed. |
| [`post.authenticity_changed`](#post-authenticity-changed) | Post authenticity changed. |
| [`post.external.created`](#post-external-created) | External post created. |
| [`post.external.updated`](#post-external-updated) | External post updated. |
| [`post.external.deleted`](#post-external-deleted) | External post deleted. |

### post.scheduled

Post scheduled.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "post.scheduled",
  "post": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "content": "Hello from Pozy",
    "status": "active",
    "scheduledFor": "2026-10-02T09:00:00.000Z",
    "publishedAt": "2026-10-02T09:00:00.000Z",
    "platforms": [
      {
        "platform": "instagram",
        "status": "active",
        "accountId": "696e0b682d0a31188e7a2ba9",
        "platformPostId": "637f799b3039e6602e83fa4f",
        "publishedUrl": "https://pozy.ai/media/example-1.jpg",
        "error": "string",
        "errorCategory": "auth_expired",
        "errorSource": "user",
        "platformError": {
          "code": 1,
          "subcode": 1,
          "message": "Hello from Pozy"
        }
      }
    ],
    "metadata": {}
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### post.published

Post published.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "post.published",
  "post": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "content": "Hello from Pozy",
    "status": "active",
    "scheduledFor": "2026-10-02T09:00:00.000Z",
    "publishedAt": "2026-10-02T09:00:00.000Z",
    "platforms": [
      {
        "platform": "instagram",
        "status": "active",
        "accountId": "696e0b682d0a31188e7a2ba9",
        "platformPostId": "637f799b3039e6602e83fa4f",
        "publishedUrl": "https://pozy.ai/media/example-1.jpg",
        "error": "string",
        "errorCategory": "auth_expired",
        "errorSource": "user",
        "platformError": {
          "code": 1,
          "subcode": 1,
          "message": "Hello from Pozy"
        }
      }
    ],
    "metadata": {}
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### post.failed

Post failed.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "post.failed",
  "post": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "content": "Hello from Pozy",
    "status": "active",
    "scheduledFor": "2026-10-02T09:00:00.000Z",
    "publishedAt": "2026-10-02T09:00:00.000Z",
    "platforms": [
      {
        "platform": "instagram",
        "status": "active",
        "accountId": "696e0b682d0a31188e7a2ba9",
        "platformPostId": "637f799b3039e6602e83fa4f",
        "publishedUrl": "https://pozy.ai/media/example-1.jpg",
        "error": "string",
        "errorCategory": "auth_expired",
        "errorSource": "user",
        "platformError": {
          "code": 1,
          "subcode": 1,
          "message": "Hello from Pozy"
        }
      }
    ],
    "metadata": {}
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### post.partial

Post partial.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "post.partial",
  "post": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "content": "Hello from Pozy",
    "status": "active",
    "scheduledFor": "2026-10-02T09:00:00.000Z",
    "publishedAt": "2026-10-02T09:00:00.000Z",
    "platforms": [
      {
        "platform": "instagram",
        "status": "active",
        "accountId": "696e0b682d0a31188e7a2ba9",
        "platformPostId": "637f799b3039e6602e83fa4f",
        "publishedUrl": "https://pozy.ai/media/example-1.jpg",
        "error": "string",
        "errorCategory": "auth_expired",
        "errorSource": "user",
        "platformError": {
          "code": 1,
          "subcode": 1,
          "message": "Hello from Pozy"
        }
      }
    ],
    "metadata": {}
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### post.cancelled

Post cancelled.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "post.cancelled",
  "post": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "content": "Hello from Pozy",
    "status": "active",
    "scheduledFor": "2026-10-02T09:00:00.000Z",
    "publishedAt": "2026-10-02T09:00:00.000Z",
    "platforms": [
      {
        "platform": "instagram",
        "status": "active",
        "accountId": "696e0b682d0a31188e7a2ba9",
        "platformPostId": "637f799b3039e6602e83fa4f",
        "publishedUrl": "https://pozy.ai/media/example-1.jpg",
        "error": "string",
        "errorCategory": "auth_expired",
        "errorSource": "user",
        "platformError": {
          "code": 1,
          "subcode": 1,
          "message": "Hello from Pozy"
        }
      }
    ],
    "metadata": {}
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### post.recycled

Post recycled.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "post.recycled",
  "post": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "content": "Hello from Pozy",
    "status": "active",
    "scheduledFor": "2026-10-02T09:00:00.000Z",
    "publishedAt": "2026-10-02T09:00:00.000Z",
    "platforms": [
      {
        "platform": "instagram",
        "status": "active",
        "accountId": "696e0b682d0a31188e7a2ba9",
        "platformPostId": "637f799b3039e6602e83fa4f",
        "publishedUrl": "https://pozy.ai/media/example-1.jpg",
        "error": "string",
        "errorCategory": "auth_expired",
        "errorSource": "user",
        "platformError": {
          "code": 1,
          "subcode": 1,
          "message": "Hello from Pozy"
        }
      }
    ],
    "metadata": {}
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### post.platform.published

Post platform published.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "post.platform.published",
  "post": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "content": "Hello from Pozy",
    "status": "active",
    "scheduledFor": "2026-10-02T09:00:00.000Z",
    "publishedAt": "2026-10-02T09:00:00.000Z",
    "platforms": [
      {
        "platform": "instagram",
        "status": "active",
        "accountId": "696e0b682d0a31188e7a2ba9",
        "platformPostId": "637f799b3039e6602e83fa4f",
        "publishedUrl": "https://pozy.ai/media/example-1.jpg",
        "error": "string",
        "errorCategory": "auth_expired",
        "errorSource": "user",
        "platformError": {
          "code": 1,
          "subcode": 1,
          "message": "Hello from Pozy"
        }
      }
    ],
    "metadata": {}
  },
  "platform": {
    "name": "Acme",
    "status": "published",
    "platformPostId": "637f799b3039e6602e83fa4f",
    "publishedUrl": "https://pozy.ai/media/example-1.jpg",
    "error": "string",
    "errorCategory": "auth_expired",
    "errorSource": "user",
    "deletedAt": "2026-10-02T09:00:00.000Z"
  },
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### post.platform.failed

Post platform failed.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "post.platform.failed",
  "post": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "content": "Hello from Pozy",
    "status": "active",
    "scheduledFor": "2026-10-02T09:00:00.000Z",
    "publishedAt": "2026-10-02T09:00:00.000Z",
    "platforms": [
      {
        "platform": "instagram",
        "status": "active",
        "accountId": "696e0b682d0a31188e7a2ba9",
        "platformPostId": "637f799b3039e6602e83fa4f",
        "publishedUrl": "https://pozy.ai/media/example-1.jpg",
        "error": "string",
        "errorCategory": "auth_expired",
        "errorSource": "user",
        "platformError": {
          "code": 1,
          "subcode": 1,
          "message": "Hello from Pozy"
        }
      }
    ],
    "metadata": {}
  },
  "platform": {
    "name": "Acme",
    "status": "published",
    "platformPostId": "637f799b3039e6602e83fa4f",
    "publishedUrl": "https://pozy.ai/media/example-1.jpg",
    "error": "string",
    "errorCategory": "auth_expired",
    "errorSource": "user",
    "deletedAt": "2026-10-02T09:00:00.000Z"
  },
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### post.platform.deleted

Post platform deleted.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "post.platform.deleted",
  "post": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "content": "Hello from Pozy",
    "status": "active",
    "scheduledFor": "2026-10-02T09:00:00.000Z",
    "publishedAt": "2026-10-02T09:00:00.000Z",
    "platforms": [
      {
        "platform": "instagram",
        "status": "active",
        "accountId": "696e0b682d0a31188e7a2ba9",
        "platformPostId": "637f799b3039e6602e83fa4f",
        "publishedUrl": "https://pozy.ai/media/example-1.jpg",
        "error": "string",
        "errorCategory": "auth_expired",
        "errorSource": "user",
        "platformError": {
          "code": 1,
          "subcode": 1,
          "message": "Hello from Pozy"
        }
      }
    ],
    "metadata": {}
  },
  "platform": {
    "name": "Acme",
    "status": "published",
    "platformPostId": "637f799b3039e6602e83fa4f",
    "publishedUrl": "https://pozy.ai/media/example-1.jpg",
    "error": "string",
    "errorCategory": "auth_expired",
    "errorSource": "user",
    "deletedAt": "2026-10-02T09:00:00.000Z"
  },
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### post.tiktok.url_resolved

TikTok post URL resolved.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "post.tiktok.url_resolved",
  "post": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "content": "Hello from Pozy",
    "status": "active",
    "scheduledFor": "2026-10-02T09:00:00.000Z",
    "publishedAt": "2026-10-02T09:00:00.000Z",
    "platforms": [
      {
        "platform": "instagram",
        "status": "active",
        "accountId": "696e0b682d0a31188e7a2ba9",
        "platformPostId": "637f799b3039e6602e83fa4f",
        "publishedUrl": "https://pozy.ai/media/example-1.jpg",
        "error": "string",
        "errorCategory": "auth_expired",
        "errorSource": "user",
        "platformError": {
          "code": 1,
          "subcode": 1,
          "message": "Hello from Pozy"
        }
      }
    ],
    "metadata": {}
  },
  "platform": {
    "name": "Acme",
    "status": "published",
    "platformPostId": "637f799b3039e6602e83fa4f",
    "publishedUrl": "https://pozy.ai/media/example-1.jpg",
    "error": "string",
    "errorCategory": "auth_expired",
    "errorSource": "user",
    "deletedAt": "2026-10-02T09:00:00.000Z"
  },
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### post.tracking_completed

Post tracking completed.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "post.tracking_completed",
  "post": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "instagram",
    "platformPostId": "637f799b3039e6602e83fa4f",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff"
  },
  "window": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "startsAt": "2026-10-02T09:00:00.000Z",
    "endsAt": "2026-10-02T09:00:00.000Z",
    "finalReadAt": "2026-10-02T09:00:00.000Z",
    "completionReason": "final_read"
  },
  "final": {
    "views": 1,
    "likes": 1,
    "comments": 1,
    "shares": 1,
    "saves": 1,
    "syncedAt": "2026-10-02T09:00:00.000Z"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### post.authenticity_changed

Post authenticity changed.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "post.authenticity_changed",
  "post": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "instagram",
    "platformPostId": "637f799b3039e6602e83fa4f",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff"
  },
  "authenticity": {
    "score": 1,
    "previousScore": 1,
    "confidence": 12.5,
    "reasons": [
      {
        "code": "string",
        "weight": 12.5
      }
    ],
    "version": "string",
    "computedAt": "2026-10-02T09:00:00.000Z"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### post.external.created

External post created.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "post.external.created",
  "post": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "instagram",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "url": "https://pozy.ai/media/example-1.jpg",
    "content": "Hello from Pozy",
    "mediaType": "string",
    "mediaItems": [
      {
        "type": "image",
        "url": "https://pozy.ai/media/example-1.jpg",
        "thumbnail": "string",
        "mediaStatus": "available",
        "unavailableReason": "platform_withheld"
      }
    ],
    "thumbnailUrl": "https://pozy.ai/media/example-1.jpg",
    "publishedAt": "2026-10-02T09:00:00.000Z",
    "mediaProductType": "string",
    "isAiGenerated": true,
    "isSharedToFeed": true,
    "mediaAudioType": "string",
    "source": "external",
    "deletedAt": "2026-10-02T09:00:00.000Z"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "instagram",
    "username": "acme"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### post.external.updated

External post updated.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "post.external.updated",
  "post": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "instagram",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "url": "https://pozy.ai/media/example-1.jpg",
    "content": "Hello from Pozy",
    "mediaType": "string",
    "mediaItems": [
      {
        "type": "image",
        "url": "https://pozy.ai/media/example-1.jpg",
        "thumbnail": "string",
        "mediaStatus": "available",
        "unavailableReason": "platform_withheld"
      }
    ],
    "thumbnailUrl": "https://pozy.ai/media/example-1.jpg",
    "publishedAt": "2026-10-02T09:00:00.000Z",
    "mediaProductType": "string",
    "isAiGenerated": true,
    "isSharedToFeed": true,
    "mediaAudioType": "string",
    "source": "external",
    "deletedAt": "2026-10-02T09:00:00.000Z"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "instagram",
    "username": "acme"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### post.external.deleted

External post deleted.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "post.external.deleted",
  "post": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "instagram",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "url": "https://pozy.ai/media/example-1.jpg",
    "content": "Hello from Pozy",
    "mediaType": "string",
    "mediaItems": [
      {
        "type": "image",
        "url": "https://pozy.ai/media/example-1.jpg",
        "thumbnail": "string",
        "mediaStatus": "available",
        "unavailableReason": "platform_withheld"
      }
    ],
    "thumbnailUrl": "https://pozy.ai/media/example-1.jpg",
    "publishedAt": "2026-10-02T09:00:00.000Z",
    "mediaProductType": "string",
    "isAiGenerated": true,
    "isSharedToFeed": true,
    "mediaAudioType": "string",
    "source": "external",
    "deletedAt": "2026-10-02T09:00:00.000Z"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "instagram",
    "username": "acme"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Accounts

| Event | When it fires |
| --- | --- |
| [`account.connected`](#account-connected) | Account connected. |
| [`account.rate_limited`](#account-rate-limited) | Mailbox sending cooldown started. |
| [`account.disconnected`](#account-disconnected) | Account disconnected. |
| [`account.permissions_changed`](#account-permissions-changed) | Account permissions changed. |
| [`account.ads.initial_sync_completed`](#account-ads-initial-sync-completed) | Ads initial sync completed. |
| [`account.ads.sync_failed`](#account-ads-sync-failed) | Ads sync failed. |
| [`account.ads.sync_recovered`](#account-ads-sync-recovered) | Ads sync recovered. |

### account.connected

Account connected.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "account.connected",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### account.rate_limited

Mailbox sending cooldown started.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "account.rate_limited",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "reason": "recipient_burst",
    "cooldownMinutes": 1,
    "resetsAt": "2026-10-02T09:00:00.000Z"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### account.disconnected

Account disconnected.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "account.disconnected",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "disconnectionType": "intentional",
    "reason": "string"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### account.permissions_changed

Account permissions changed.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "account.permissions_changed",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "oauthAppId": "629a39de8c0a63af5a05067c",
    "missingScopeAreas": [
      "posting"
    ],
    "reason": "string"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### account.ads.initial_sync_completed

Ads initial sync completed.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "account.ads.initial_sync_completed",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "platformUserId": "60c5beb6ca4037bb9ff5117a",
    "profilePicture": "https://pozy.ai/media/example-1.jpg",
    "platformAdAccountId": "673c621a82c88059710de3fd",
    "platformAdAccountIds": [
      "instagram"
    ]
  },
  "sync": {
    "status": "success",
    "totalAds": 42,
    "synced": 1,
    "failed": 1,
    "error": "string",
    "errorCode": "string",
    "errorSubcode": "string",
    "errorCategory": "token_invalid"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### account.ads.sync_failed

Ads sync failed.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "account.ads.sync_failed",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "adAccount": {
    "platformAdAccountId": "673c621a82c88059710de3fd",
    "name": "Acme"
  },
  "sync": {
    "lastSuccessfulSyncAt": "2026-10-02T09:00:00.000Z",
    "failureCount": 42,
    "errorCategory": "ad_account_not_listed",
    "error": "string"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### account.ads.sync_recovered

Ads sync recovered.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "account.ads.sync_recovered",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "adAccount": {
    "platformAdAccountId": "673c621a82c88059710de3fd",
    "name": "Acme"
  },
  "sync": {
    "lastSuccessfulSyncAt": "2026-10-02T09:00:00.000Z",
    "failingSince": "2026-10-02T09:00:00.000Z"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Calendar

| Event | When it fires |
| --- | --- |
| [`calendar.event.created`](#calendar-event-created) | Calendar event created. |
| [`calendar.event.updated`](#calendar-event-updated) | Calendar event updated. |
| [`calendar.event.deleted`](#calendar-event-deleted) | Calendar event deleted. |

### calendar.event.created

Calendar event created.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "calendar.event.created",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "calendarEvent": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "changeType": "created"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### calendar.event.updated

Calendar event updated.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "calendar.event.updated",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "calendarEvent": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "changeType": "created"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### calendar.event.deleted

Calendar event deleted.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "calendar.event.deleted",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "calendarEvent": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "changeType": "created"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Files

| Event | When it fires |
| --- | --- |
| [`file.created`](#file-created) | File created. |
| [`file.updated`](#file-updated) | File updated. |
| [`file.picked`](#file-picked) | Files picked. |
| [`file.deleted`](#file-deleted) | File deleted. |

### file.created

File created.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "file.created",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "file": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "changeType": "created"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### file.updated

File updated.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "file.updated",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "file": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "changeType": "created"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### file.picked

Files picked.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "file.picked",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "picker": {
    "sessionId": "6c7e2817e4b11c261dacecee",
    "files": [
      {
        "id": "6bfebd43ddc270f6d2c56fc5",
        "name": "Acme",
        "mimeType": "image/jpeg",
        "kind": "file"
      }
    ]
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### file.deleted

File deleted.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "file.deleted",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "file": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "changeType": "created"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Contacts

| Event | When it fires |
| --- | --- |
| [`contact.updated`](#contact-updated) | Contact updated. |
| [`contact.deleted`](#contact-deleted) | Contact deleted. |
| [`contact.tag_added`](#contact-tag-added) | Contact tag added. |
| [`contact.tag_removed`](#contact-tag-removed) | Contact tag removed. |
| [`contact.field_changed`](#contact-field-changed) | Contact field changed. |

### contact.updated

Contact updated.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "contact.updated",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "contact": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "changeType": "updated"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### contact.deleted

Contact deleted.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "contact.deleted",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "contact": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "changeType": "updated"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### contact.tag_added

Contact tag added.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "contact.tag_added",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "contact": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "tag": "string",
  "source": "api"
}
```

### contact.tag_removed

Contact tag removed.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "contact.tag_removed",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "contact": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "tag": "string",
  "source": "api"
}
```

### contact.field_changed

Contact field changed.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "contact.field_changed",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "contact": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "field": "string",
  "previousValue": "string",
  "value": "string",
  "source": "api"
}
```

## Analytics

| Event | When it fires |
| --- | --- |
| [`analytics.synced`](#analytics-synced) | Analytics synced. |

### analytics.synced

Analytics synced.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "analytics.synced",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme"
  },
  "sync": {
    "syncedAt": "2026-10-02T09:00:00.000Z",
    "postsUpdated": 1
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Messages

| Event | When it fires |
| --- | --- |
| [`message.received`](#message-received) | Message received. |
| [`message.sent`](#message-sent) | Message sent. |
| [`message.edited`](#message-edited) | Message edited. |
| [`message.deleted`](#message-deleted) | Message deleted. |
| [`message.delivered`](#message-delivered) | Message delivered. |
| [`message.read`](#message-read) | Message read. |
| [`message.played`](#message-played) | Message played. |
| [`message.failed`](#message-failed) | Message delivery failed. |

### message.received

Message received.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "message.received",
  "message": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "conversationId": "6e525f3820fc636aa96d2ee9",
    "platform": "instagram",
    "platformMessageId": "6d02da82d3a496146d890d30",
    "direction": "incoming",
    "text": "Hello from Pozy",
    "attachments": [
      {
        "type": "string",
        "originalType": "string",
        "mimeType": "image/jpeg",
        "url": "https://pozy.ai/media/example-1.jpg",
        "payload": {
          "voice": true
        }
      }
    ],
    "sender": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "contactId": "642d31f43531ce7d44aa5013",
      "name": "Acme",
      "username": "acme",
      "picture": "string",
      "phoneNumber": "+14155550123",
      "businessScopedUserId": "61f84cc05876a1c25c483817",
      "parentBusinessScopedUserId": "66ba6a8970cf071a451ae422",
      "whatsappUsername": "acme",
      "instagramProfile": {
        "isFollower": true,
        "isFollowing": true,
        "followerCount": 42,
        "isVerified": true
      }
    },
    "sentAt": "2026-10-02T09:00:00.000Z",
    "isRead": true,
    "sentVia": "human",
    "automationId": "66795db1e7f0419ba4a14e79",
    "workflowId": "6e299f518f373bfd669857c4",
    "executionId": "6c1d5173be24d1f9e4e6f57f",
    "broadcastId": "6ce1988a4c4f8bc6d3ca157a",
    "sequenceId": "67ea9094754757c09f3c81ba"
  },
  "conversation": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platformConversationId": "60cd5fdd6c0ca757eac487f2",
    "participantId": "6f0150243551cb6ee41f35e0",
    "participantName": "Acme",
    "participantUsername": "acme",
    "participantPicture": "string",
    "status": "active",
    "contactId": "642d31f43531ce7d44aa5013"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "pageId": "675e1e95e076854531b4d051"
  },
  "metadata": {
    "standby": true,
    "quotedMessageId": "6b97b5b814db65e55ce67c7e",
    "quotedMessage": {
      "messageId": "62d191e7089bc48b8ea56b35",
      "platformMessageId": "6d02da82d3a496146d890d30"
    },
    "quickReplyPayload": "string",
    "postbackPayload": "string",
    "postbackTitle": "string",
    "callbackData": "string",
    "interactiveType": "button_reply",
    "interactiveId": "69d5f971d97b0d1ea9834b06",
    "buttonPayload": "string",
    "flowResponseJson": "string",
    "flowResponseData": {},
    "nfmReplyName": "Acme",
    "order": {
      "catalog_id": "654014defa96341e5591d34f",
      "text": "Hello from Pozy",
      "product_items": [
        {
          "product_retailer_id": "6cef44573a71470d70ff2027",
          "quantity": 1,
          "item_price": 12.5,
          "currency": "USD"
        }
      ]
    },
    "referredProduct": {
      "catalog_id": "654014defa96341e5591d34f",
      "product_retailer_id": "6cef44573a71470d70ff2027"
    },
    "forwarded": true,
    "frequentlyForwarded": true,
    "location": {
      "latitude": 12.5,
      "longitude": 12.5,
      "name": "Acme",
      "address": "string"
    },
    "contacts": [
      {}
    ],
    "contactsOrigin": "contact_request",
    "storyReply": {
      "storyId": "62c55df6d7c6e25c9304798b",
      "storyUrl": "https://pozy.ai/media/example-1.jpg"
    },
    "isStoryMention": true,
    "referral": {
      "ctwa_clid": "692eb88a2c90929f2394053b",
      "source_id": "67f1aea3f113146efbe24336",
      "source_type": "string",
      "source_url": "https://pozy.ai/media/example-1.jpg",
      "headline": "Launch day",
      "body": "string",
      "media_type": "string",
      "image_url": "https://pozy.ai/media/example-1.jpg",
      "video_url": "https://pozy.ai/media/example-1.jpg",
      "thumbnail_url": "https://pozy.ai/media/example-1.jpg",
      "welcome_message": {
        "text": "Hello from Pozy"
      },
      "ad_id": "61378864b454dad84552e9be",
      "ref": "string",
      "source": "string",
      "type": "string",
      "referer_uri": "string",
      "ads_context_data": {
        "ad_title": "string",
        "photo_url": "https://pozy.ai/media/example-1.jpg",
        "video_url": "https://pozy.ai/media/example-1.jpg",
        "post_id": "6a9a6b4bd49f0098d9aee860",
        "product_id": "6082076f319d341f54d8df36",
        "flow_id": "6b3aa235a01c0fe058cfaf00"
      }
    },
    "ad": {
      "adId": "6f40fa2fb0a7e728dd1a73b7",
      "name": "Acme",
      "synced": true,
      "campaignId": "65a3737dd8b11ea61f199e6e",
      "campaignName": "Acme",
      "adSetId": "60484b408d44e7c2492bfec5",
      "adSetName": "Acme",
      "adAccountId": "666219aad7bab67ace411e4f",
      "adAccountName": "Acme",
      "platformPostId": "637f799b3039e6602e83fa4f",
      "isExternal": true
    },
    "unsupported": {
      "code": 1,
      "title": "Launch day",
      "details": "string",
      "type": "string"
    },
    "noRenderableContent": true,
    "tiktokMessageType": "Hello from Pozy"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### message.sent

Message sent.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "message.sent",
  "message": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "conversationId": "6e525f3820fc636aa96d2ee9",
    "platform": "instagram",
    "platformMessageId": "6d02da82d3a496146d890d30",
    "direction": "incoming",
    "text": "Hello from Pozy",
    "attachments": [
      {
        "type": "string",
        "originalType": "string",
        "url": "https://pozy.ai/media/example-1.jpg",
        "payload": {}
      }
    ],
    "sender": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "contactId": "642d31f43531ce7d44aa5013",
      "name": "Acme",
      "username": "acme",
      "picture": "string"
    },
    "sentAt": "2026-10-02T09:00:00.000Z",
    "isRead": true,
    "source": "whatsapp_business_app",
    "sentVia": "human",
    "automationId": "66795db1e7f0419ba4a14e79",
    "workflowId": "6e299f518f373bfd669857c4",
    "executionId": "6c1d5173be24d1f9e4e6f57f",
    "broadcastId": "6ce1988a4c4f8bc6d3ca157a",
    "sequenceId": "67ea9094754757c09f3c81ba"
  },
  "pricing": {
    "billable": true,
    "pricingModel": "string",
    "category": "string",
    "type": "string"
  },
  "billingConversation": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "expiresAt": "2026-10-02T09:00:00.000Z",
    "originType": "string"
  },
  "conversation": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platformConversationId": "60cd5fdd6c0ca757eac487f2",
    "participantId": "6f0150243551cb6ee41f35e0",
    "participantName": "Acme",
    "participantUsername": "acme",
    "participantPicture": "string",
    "status": "active",
    "contactId": "642d31f43531ce7d44aa5013"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "pageId": "675e1e95e076854531b4d051"
  },
  "metadata": {
    "metaInteractive": {},
    "location": {
      "latitude": 12.5,
      "longitude": 12.5,
      "name": "Acme",
      "address": "string"
    },
    "contacts": [
      {}
    ],
    "quotedMessageId": "6b97b5b814db65e55ce67c7e",
    "threadTs": "string",
    "tiktokMessageType": "Hello from Pozy"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### message.edited

Message edited.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "message.edited",
  "message": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "conversationId": "6e525f3820fc636aa96d2ee9",
    "platform": "instagram",
    "platformMessageId": "6d02da82d3a496146d890d30",
    "direction": "incoming",
    "text": "Hello from Pozy",
    "attachments": [
      {
        "type": "string",
        "url": "https://pozy.ai/media/example-1.jpg",
        "payload": {
          "voice": true
        }
      }
    ],
    "sender": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "contactId": "642d31f43531ce7d44aa5013",
      "name": "Acme",
      "username": "acme",
      "picture": "string",
      "phoneNumber": "+14155550123",
      "businessScopedUserId": "61f84cc05876a1c25c483817",
      "parentBusinessScopedUserId": "66ba6a8970cf071a451ae422",
      "whatsappUsername": "acme",
      "instagramProfile": {
        "isFollower": true,
        "isFollowing": true,
        "followerCount": 42,
        "isVerified": true
      }
    },
    "sentAt": "2026-10-02T09:00:00.000Z",
    "isRead": true
  },
  "editHistory": [
    {
      "text": "Hello from Pozy",
      "attachments": [
        {
          "type": "string",
          "url": "https://pozy.ai/media/example-1.jpg",
          "payload": {}
        }
      ],
      "editedAt": "2026-10-02T09:00:00.000Z"
    }
  ],
  "editCount": 42,
  "editedAt": "2026-10-02T09:00:00.000Z",
  "conversation": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platformConversationId": "60cd5fdd6c0ca757eac487f2",
    "participantId": "6f0150243551cb6ee41f35e0",
    "participantName": "Acme",
    "participantUsername": "acme",
    "participantPicture": "string",
    "status": "active",
    "contactId": "642d31f43531ce7d44aa5013"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "pageId": "675e1e95e076854531b4d051"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### message.deleted

Message deleted.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "message.deleted",
  "message": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "conversationId": "6e525f3820fc636aa96d2ee9",
    "platform": "instagram",
    "platformMessageId": "6d02da82d3a496146d890d30",
    "direction": "incoming",
    "text": "Hello from Pozy",
    "attachments": [
      {
        "type": "string",
        "url": "https://pozy.ai/media/example-1.jpg",
        "payload": {
          "voice": true
        }
      }
    ],
    "sender": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "contactId": "642d31f43531ce7d44aa5013",
      "name": "Acme",
      "username": "acme",
      "picture": "string",
      "phoneNumber": "+14155550123",
      "businessScopedUserId": "61f84cc05876a1c25c483817",
      "parentBusinessScopedUserId": "66ba6a8970cf071a451ae422",
      "whatsappUsername": "acme",
      "instagramProfile": {
        "isFollower": true,
        "isFollowing": true,
        "followerCount": 42,
        "isVerified": true
      }
    },
    "sentAt": "2026-10-02T09:00:00.000Z",
    "isRead": true
  },
  "deletedAt": "2026-10-02T09:00:00.000Z",
  "conversation": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platformConversationId": "60cd5fdd6c0ca757eac487f2",
    "participantId": "6f0150243551cb6ee41f35e0",
    "participantName": "Acme",
    "participantUsername": "acme",
    "participantPicture": "string",
    "status": "active",
    "contactId": "642d31f43531ce7d44aa5013"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "pageId": "675e1e95e076854531b4d051"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### message.delivered

Message delivered.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "message.delivered",
  "message": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "conversationId": "6e525f3820fc636aa96d2ee9",
    "platform": "instagram",
    "platformMessageId": "6d02da82d3a496146d890d30",
    "direction": "incoming",
    "text": "Hello from Pozy",
    "attachments": [
      {
        "type": "string",
        "url": "https://pozy.ai/media/example-1.jpg",
        "payload": {
          "voice": true
        }
      }
    ],
    "sender": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "contactId": "642d31f43531ce7d44aa5013",
      "name": "Acme",
      "username": "acme",
      "picture": "string",
      "phoneNumber": "+14155550123",
      "businessScopedUserId": "61f84cc05876a1c25c483817",
      "parentBusinessScopedUserId": "66ba6a8970cf071a451ae422",
      "whatsappUsername": "acme",
      "instagramProfile": {
        "isFollower": true,
        "isFollowing": true,
        "followerCount": 42,
        "isVerified": true
      }
    },
    "sentAt": "2026-10-02T09:00:00.000Z",
    "isRead": true
  },
  "statusAt": "2026-10-02T09:00:00.000Z",
  "error": {
    "code": 1,
    "title": "Launch day",
    "message": "Hello from Pozy",
    "details": "string",
    "href": "https://pozy.ai/media/example-1.jpg",
    "explanation": "string"
  },
  "pricing": {
    "billable": true,
    "pricingModel": "string",
    "category": "string",
    "type": "string"
  },
  "billingConversation": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "expiresAt": "2026-10-02T09:00:00.000Z",
    "originType": "string"
  },
  "conversation": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platformConversationId": "60cd5fdd6c0ca757eac487f2",
    "participantId": "6f0150243551cb6ee41f35e0",
    "participantName": "Acme",
    "participantUsername": "acme",
    "participantPicture": "string",
    "status": "active",
    "contactId": "642d31f43531ce7d44aa5013"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "pageId": "675e1e95e076854531b4d051"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### message.read

Message read.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "message.read",
  "message": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "conversationId": "6e525f3820fc636aa96d2ee9",
    "platform": "instagram",
    "platformMessageId": "6d02da82d3a496146d890d30",
    "direction": "incoming",
    "text": "Hello from Pozy",
    "attachments": [
      {
        "type": "string",
        "url": "https://pozy.ai/media/example-1.jpg",
        "payload": {
          "voice": true
        }
      }
    ],
    "sender": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "contactId": "642d31f43531ce7d44aa5013",
      "name": "Acme",
      "username": "acme",
      "picture": "string",
      "phoneNumber": "+14155550123",
      "businessScopedUserId": "61f84cc05876a1c25c483817",
      "parentBusinessScopedUserId": "66ba6a8970cf071a451ae422",
      "whatsappUsername": "acme",
      "instagramProfile": {
        "isFollower": true,
        "isFollowing": true,
        "followerCount": 42,
        "isVerified": true
      }
    },
    "sentAt": "2026-10-02T09:00:00.000Z",
    "isRead": true
  },
  "statusAt": "2026-10-02T09:00:00.000Z",
  "error": {
    "code": 1,
    "title": "Launch day",
    "message": "Hello from Pozy",
    "details": "string",
    "href": "https://pozy.ai/media/example-1.jpg",
    "explanation": "string"
  },
  "pricing": {
    "billable": true,
    "pricingModel": "string",
    "category": "string",
    "type": "string"
  },
  "billingConversation": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "expiresAt": "2026-10-02T09:00:00.000Z",
    "originType": "string"
  },
  "conversation": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platformConversationId": "60cd5fdd6c0ca757eac487f2",
    "participantId": "6f0150243551cb6ee41f35e0",
    "participantName": "Acme",
    "participantUsername": "acme",
    "participantPicture": "string",
    "status": "active",
    "contactId": "642d31f43531ce7d44aa5013"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "pageId": "675e1e95e076854531b4d051"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### message.played

Message played.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "message.played",
  "message": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "conversationId": "6e525f3820fc636aa96d2ee9",
    "platform": "instagram",
    "platformMessageId": "6d02da82d3a496146d890d30",
    "direction": "incoming",
    "text": "Hello from Pozy",
    "attachments": [
      {
        "type": "string",
        "url": "https://pozy.ai/media/example-1.jpg",
        "payload": {
          "voice": true
        }
      }
    ],
    "sender": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "contactId": "642d31f43531ce7d44aa5013",
      "name": "Acme",
      "username": "acme",
      "picture": "string",
      "phoneNumber": "+14155550123",
      "businessScopedUserId": "61f84cc05876a1c25c483817",
      "parentBusinessScopedUserId": "66ba6a8970cf071a451ae422",
      "whatsappUsername": "acme",
      "instagramProfile": {
        "isFollower": true,
        "isFollowing": true,
        "followerCount": 42,
        "isVerified": true
      }
    },
    "sentAt": "2026-10-02T09:00:00.000Z",
    "isRead": true
  },
  "statusAt": "2026-10-02T09:00:00.000Z",
  "error": {
    "code": 1,
    "title": "Launch day",
    "message": "Hello from Pozy",
    "details": "string",
    "href": "https://pozy.ai/media/example-1.jpg",
    "explanation": "string"
  },
  "pricing": {
    "billable": true,
    "pricingModel": "string",
    "category": "string",
    "type": "string"
  },
  "billingConversation": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "expiresAt": "2026-10-02T09:00:00.000Z",
    "originType": "string"
  },
  "conversation": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platformConversationId": "60cd5fdd6c0ca757eac487f2",
    "participantId": "6f0150243551cb6ee41f35e0",
    "participantName": "Acme",
    "participantUsername": "acme",
    "participantPicture": "string",
    "status": "active",
    "contactId": "642d31f43531ce7d44aa5013"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "pageId": "675e1e95e076854531b4d051"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### message.failed

Message delivery failed.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "message.failed",
  "message": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "conversationId": "6e525f3820fc636aa96d2ee9",
    "platform": "instagram",
    "platformMessageId": "6d02da82d3a496146d890d30",
    "direction": "incoming",
    "text": "Hello from Pozy",
    "attachments": [
      {
        "type": "string",
        "url": "https://pozy.ai/media/example-1.jpg",
        "payload": {
          "voice": true
        }
      }
    ],
    "sender": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "contactId": "642d31f43531ce7d44aa5013",
      "name": "Acme",
      "username": "acme",
      "picture": "string",
      "phoneNumber": "+14155550123",
      "businessScopedUserId": "61f84cc05876a1c25c483817",
      "parentBusinessScopedUserId": "66ba6a8970cf071a451ae422",
      "whatsappUsername": "acme",
      "instagramProfile": {
        "isFollower": true,
        "isFollowing": true,
        "followerCount": 42,
        "isVerified": true
      }
    },
    "sentAt": "2026-10-02T09:00:00.000Z",
    "isRead": true
  },
  "statusAt": "2026-10-02T09:00:00.000Z",
  "error": {
    "code": 1,
    "title": "Launch day",
    "message": "Hello from Pozy",
    "details": "string",
    "href": "https://pozy.ai/media/example-1.jpg",
    "explanation": "string"
  },
  "pricing": {
    "billable": true,
    "pricingModel": "string",
    "category": "string",
    "type": "string"
  },
  "billingConversation": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "expiresAt": "2026-10-02T09:00:00.000Z",
    "originType": "string"
  },
  "conversation": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platformConversationId": "60cd5fdd6c0ca757eac487f2",
    "participantId": "6f0150243551cb6ee41f35e0",
    "participantName": "Acme",
    "participantUsername": "acme",
    "participantPicture": "string",
    "status": "active",
    "contactId": "642d31f43531ce7d44aa5013"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "pageId": "675e1e95e076854531b4d051"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Conversations

| Event | When it fires |
| --- | --- |
| [`conversation.control_changed`](#conversation-control-changed) | Conversation control changed. |
| [`conversation.started`](#conversation-started) | Conversation started. |

### conversation.control_changed

Conversation control changed.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "conversation.control_changed",
  "conversation": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "instagram",
    "platformConversationId": "60cd5fdd6c0ca757eac487f2",
    "participantId": "6f0150243551cb6ee41f35e0",
    "participantName": "Acme",
    "participantUsername": "acme",
    "participantPicture": "string",
    "status": "active",
    "contactId": "642d31f43531ce7d44aa5013"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "pageId": "675e1e95e076854531b4d051"
  },
  "control": {
    "owner": "app",
    "previousOwner": "app",
    "ownerAppId": "66900a31b01db011b0d3137c",
    "metadata": "string"
  },
  "changedAt": "2026-10-02T09:00:00.000Z",
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### conversation.started

Conversation started.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "conversation.started",
  "conversation": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "instagram",
    "platformConversationId": "60cd5fdd6c0ca757eac487f2",
    "participantId": "6f0150243551cb6ee41f35e0",
    "participantName": "Acme",
    "participantUsername": "acme",
    "participantPicture": "string",
    "status": "active",
    "contactId": "642d31f43531ce7d44aa5013",
    "metadata": {
      "ctwa_clid": "692eb88a2c90929f2394053b",
      "ctwa_source_id": "6bf4334a1a6cba0bd31d44ae",
      "ctwa_source_type": "string",
      "ctwa_source_url": "https://pozy.ai/media/example-1.jpg",
      "ctwa_headline": "string",
      "ctwa_body": "string",
      "ctwa_media_type": "string",
      "ctwa_image_url": "https://pozy.ai/media/example-1.jpg",
      "ctwa_video_url": "https://pozy.ai/media/example-1.jpg",
      "ctwa_thumbnail_url": "https://pozy.ai/media/example-1.jpg",
      "ctwa_captured_at": "2026-10-02T09:00:00.000Z",
      "meta_ad_id": "61e6bf8a5c69195f41e50bb7",
      "meta_ad_source": "string",
      "meta_ad_type": "string",
      "meta_ad_ref": "string",
      "meta_ad_title": "string",
      "meta_ad_photo_url": "https://pozy.ai/media/example-1.jpg",
      "meta_ad_video_url": "https://pozy.ai/media/example-1.jpg",
      "meta_ad_post_id": "65196d015f4a678a60d69639",
      "meta_ad_product_id": "6ea27f3b17ac3128973b7ea9",
      "meta_ad_flow_id": "68770d6fe4e2e877d0403360",
      "meta_ad_captured_at": "2026-10-02T09:00:00.000Z"
    },
    "adAttribution": {
      "adId": "6f40fa2fb0a7e728dd1a73b7",
      "name": "Acme",
      "synced": true,
      "campaignId": "65a3737dd8b11ea61f199e6e",
      "campaignName": "Acme",
      "adSetId": "60484b408d44e7c2492bfec5",
      "adSetName": "Acme",
      "adAccountId": "666219aad7bab67ace411e4f",
      "adAccountName": "Acme",
      "platformPostId": "637f799b3039e6602e83fa4f",
      "isExternal": true
    }
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "pageId": "675e1e95e076854531b4d051"
  },
  "startedAt": "2026-10-02T09:00:00.000Z",
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Calls

| Event | When it fires |
| --- | --- |
| [`call.received`](#call-received) | Call received. |
| [`call.ended`](#call-ended) | Call ended. |
| [`call.failed`](#call-failed) | Call failed. |
| [`call.permission_request`](#call-permission-request) | Call permission request reply. |

### call.received

Call received.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "call.received",
  "call": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "metaCallId": "621ba4a13e5466fc480338ff",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "phoneNumberId": "698fba0989716df44adb771f",
    "direction": "inbound",
    "from": "+14155550123",
    "to": "+14155550123",
    "forwardTo": "string",
    "contactId": "642d31f43531ce7d44aa5013",
    "conversationId": "6e525f3820fc636aa96d2ee9",
    "startedAt": "2026-10-02T09:00:00.000Z"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "pageId": "675e1e95e076854531b4d051"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### call.ended

Call ended.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "call.ended",
  "call": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "metaCallId": "621ba4a13e5466fc480338ff",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "phoneNumberId": "698fba0989716df44adb771f",
    "direction": "inbound",
    "from": "+14155550123",
    "to": "+14155550123",
    "startedAt": "2026-10-02T09:00:00.000Z",
    "endedAt": "2026-10-02T09:00:00.000Z",
    "durationSeconds": 1,
    "endReason": "hangup",
    "hangupCause": "string",
    "sipHangupCause": "string",
    "isVoicemail": true,
    "callErrors": [
      {
        "code": 1,
        "message": "Hello from Pozy"
      }
    ],
    "recordingUrl": "https://pozy.ai/media/example-1.jpg",
    "recordingExpiresAt": "2026-10-02T09:00:00.000Z",
    "billing": {
      "metaCostUSD": 12.5,
      "carrierCostUSD": 12.5,
      "recordingCostUSD": 12.5,
      "billableCostUSD": 12.5,
      "totalCostUSD": 12.5
    }
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "pageId": "675e1e95e076854531b4d051"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### call.failed

Call failed.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "call.failed",
  "call": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "metaCallId": "621ba4a13e5466fc480338ff",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "phoneNumberId": "698fba0989716df44adb771f",
    "direction": "inbound",
    "from": "+14155550123",
    "to": "+14155550123",
    "failedAt": "2026-10-02T09:00:00.000Z",
    "error": {
      "code": 1,
      "message": "Hello from Pozy"
    }
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "pageId": "675e1e95e076854531b4d051"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### call.permission_request

Call permission request reply.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "call.permission_request",
  "permission": {
    "from": "+14155550123",
    "response": "accept",
    "isPermanent": true,
    "expirationTimestamp": "2026-10-02T09:00:00.000Z",
    "responseSource": "string"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "pageId": "675e1e95e076854531b4d051"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Reactions

| Event | When it fires |
| --- | --- |
| [`reaction.received`](#reaction-received) | Reaction received. |

### reaction.received

Reaction received.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "reaction.received",
  "reaction": {
    "emoji": "string",
    "action": "added",
    "messageId": "62d191e7089bc48b8ea56b35",
    "platformMessageId": "6d02da82d3a496146d890d30",
    "sender": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "contactId": "642d31f43531ce7d44aa5013",
      "name": "Acme",
      "username": "acme",
      "picture": "string",
      "phoneNumber": "+14155550123"
    },
    "reactedAt": "2026-10-02T09:00:00.000Z"
  },
  "conversation": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platformConversationId": "60cd5fdd6c0ca757eac487f2",
    "participantId": "6f0150243551cb6ee41f35e0",
    "participantName": "Acme",
    "participantUsername": "acme",
    "participantPicture": "string",
    "status": "active",
    "contactId": "642d31f43531ce7d44aa5013"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "pageId": "675e1e95e076854531b4d051"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Referrals

| Event | When it fires |
| --- | --- |
| [`referral.received`](#referral-received) | Referral received. |

### referral.received

Referral received.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "referral.received",
  "referral": {
    "ref": "string",
    "source": "string",
    "type": "string",
    "referer_uri": "string",
    "ad_id": "61378864b454dad84552e9be",
    "ads_context_data": {
      "ad_title": "string",
      "photo_url": "https://pozy.ai/media/example-1.jpg",
      "video_url": "https://pozy.ai/media/example-1.jpg",
      "post_id": "6a9a6b4bd49f0098d9aee860",
      "product_id": "6082076f319d341f54d8df36",
      "flow_id": "6b3aa235a01c0fe058cfaf00"
    }
  },
  "sender": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "contactId": "642d31f43531ce7d44aa5013"
  },
  "conversation": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platformConversationId": "60cd5fdd6c0ca757eac487f2",
    "participantId": "6f0150243551cb6ee41f35e0",
    "participantName": "Acme",
    "participantUsername": "acme",
    "participantPicture": "string",
    "status": "active",
    "contactId": "642d31f43531ce7d44aa5013"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme",
    "pageId": "675e1e95e076854531b4d051"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Comments

| Event | When it fires |
| --- | --- |
| [`comment.received`](#comment-received) | Comment received. |

### comment.received

Comment received.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "comment.received",
  "comment": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "postId": "6108a2cc742cb4e991051e0c",
    "platformPostId": "637f799b3039e6602e83fa4f",
    "platform": "instagram",
    "text": "Hello from Pozy",
    "author": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "username": "acme",
      "name": "Acme",
      "picture": "string",
      "isOwnAccount": true,
      "instagramProfile": {
        "isFollower": true,
        "isFollowing": true,
        "followerCount": 42,
        "isVerified": true
      }
    },
    "createdAt": "2026-10-02T09:00:00.000Z",
    "isReply": true,
    "parentCommentId": "6380ba8c62fab0e992f2a1bc",
    "isLive": true,
    "ad": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "title": "Launch day",
      "originalMediaId": "62013ca0082ce309f559ddae",
      "promotionStatus": "active",
      "isDarkPost": true
    },
    "attachment": {
      "type": "string",
      "imageUrl": "https://pozy.ai/media/example-1.jpg",
      "url": "https://pozy.ai/media/example-1.jpg"
    }
  },
  "post": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platformPostId": "637f799b3039e6602e83fa4f",
    "content": "Hello from Pozy",
    "imageUrl": "https://pozy.ai/media/example-1.jpg",
    "permalink": "string"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "instagram",
    "username": "acme"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Reviews

| Event | When it fires |
| --- | --- |
| [`review.new`](#review-new) | Review new. |
| [`review.updated`](#review-updated) | Review updated. |
| [`review.deleted`](#review-deleted) | Review deleted. |
| [`review.restored`](#review-restored) | Review restored. |

### review.new

Review new.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "review.new",
  "review": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "googlebusiness",
    "rating": 1,
    "text": "Hello from Pozy",
    "reviewer": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "name": "Acme",
      "profileImage": "string"
    },
    "createdAt": "2026-10-02T09:00:00.000Z",
    "hasReply": true,
    "reply": {
      "text": "Hello from Pozy",
      "createdAt": "2026-10-02T09:00:00.000Z"
    }
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "instagram",
    "username": "acme"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### review.updated

Review updated.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "review.updated",
  "review": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "googlebusiness",
    "rating": 1,
    "text": "Hello from Pozy",
    "reviewer": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "name": "Acme",
      "profileImage": "string"
    },
    "createdAt": "2026-10-02T09:00:00.000Z",
    "hasReply": true,
    "reply": {
      "text": "Hello from Pozy",
      "createdAt": "2026-10-02T09:00:00.000Z"
    }
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "instagram",
    "username": "acme"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### review.deleted

Review deleted.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "review.deleted",
  "review": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "googlebusiness",
    "rating": 1,
    "createdAt": "2026-10-02T09:00:00.000Z",
    "lastSeenAt": "2026-10-02T09:00:00.000Z"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "instagram",
    "username": "acme"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### review.restored

Review restored.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "review.restored",
  "review": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "googlebusiness",
    "rating": 1,
    "text": "Hello from Pozy",
    "reviewer": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "name": "Acme",
      "profileImage": "string"
    },
    "createdAt": "2026-10-02T09:00:00.000Z",
    "hasReply": true,
    "reply": {
      "text": "Hello from Pozy",
      "createdAt": "2026-10-02T09:00:00.000Z"
    }
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "instagram",
    "username": "acme"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Lead forms

| Event | When it fires |
| --- | --- |
| [`lead.received`](#lead-received) | Lead received. |

### lead.received

Lead received.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "lead.received",
  "lead": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "leadgenId": "6dca97cccbf47a98016ac05b",
    "formId": "6da2ff1d8c680bca61eb524a",
    "formName": "Acme",
    "adId": "6f40fa2fb0a7e728dd1a73b7",
    "adsetId": "6766358a9af7b9dbb7d42ea6",
    "campaignId": "65a3737dd8b11ea61f199e6e",
    "fields": {
      "key": "string"
    },
    "consents": {
      "0": {
        "checkboxKey": "string",
        "isChecked": true
      }
    },
    "isOrganic": true,
    "createdAt": "2026-10-02T09:00:00.000Z"
  },
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "facebook",
    "profileId": "6a0b6573846efc28aaa9a3ff"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Ads

| Event | When it fires |
| --- | --- |
| [`ad.status_changed`](#ad-status-changed) | Ad status changed. |
| [`ad.review.approved`](#ad-review-approved) | Ad review approved. |
| [`ad.review.rejected`](#ad-review-rejected) | Ad review rejected. |
| [`ad.delivery_issue`](#ad-delivery-issue) | Ad delivery issue. |
| [`ad.video.processed`](#ad-video-processed) | Ad video processed. |

### ad.status_changed

Ad status changed.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "ad.status_changed",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "adObject": {
    "level": "CAMPAIGN",
    "platformId": "648aa9da2e1bf42f668d6ef0",
    "platformAdAccountId": "673c621a82c88059710de3fd"
  },
  "status": {
    "raw": "string"
  },
  "error": {
    "code": "string",
    "summary": "string",
    "message": "Hello from Pozy"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### ad.review.approved

Ad review approved.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "ad.review.approved",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "adObject": {
    "level": "AD",
    "platformId": "648aa9da2e1bf42f668d6ef0",
    "platformAdAccountId": "673c621a82c88059710de3fd",
    "adId": "6f40fa2fb0a7e728dd1a73b7",
    "name": "Acme"
  },
  "review": {
    "status": "approved",
    "raw": "string",
    "reasons": [
      {
        "message": "Hello from Pozy"
      }
    ]
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### ad.review.rejected

Ad review rejected.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "ad.review.rejected",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "adObject": {
    "level": "AD",
    "platformId": "648aa9da2e1bf42f668d6ef0",
    "platformAdAccountId": "673c621a82c88059710de3fd",
    "adId": "6f40fa2fb0a7e728dd1a73b7",
    "name": "Acme"
  },
  "review": {
    "status": "approved",
    "raw": "string",
    "reasons": [
      {
        "message": "Hello from Pozy"
      }
    ]
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### ad.delivery_issue

Ad delivery issue.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "ad.delivery_issue",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "adObject": {
    "level": "AD",
    "platformId": "648aa9da2e1bf42f668d6ef0",
    "platformAdAccountId": "673c621a82c88059710de3fd",
    "adId": "6f40fa2fb0a7e728dd1a73b7",
    "name": "Acme"
  },
  "issue": {
    "raw": "string",
    "reasons": [
      {
        "message": "Hello from Pozy"
      }
    ]
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### ad.video.processed

Ad video processed.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "ad.video.processed",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "video": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platformAdAccountId": "673c621a82c88059710de3fd",
    "status": "ready",
    "error": "string",
    "thumbnailUrl": "https://pozy.ai/media/example-1.jpg"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Campaigns

| Event | When it fires |
| --- | --- |
| [`campaign.budget.depleted`](#campaign-budget-depleted) | Campaign budget depleted. |

### campaign.budget.depleted

Campaign budget depleted.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "campaign.budget.depleted",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "adObject": {
    "level": "CAMPAIGN",
    "platformId": "648aa9da2e1bf42f668d6ef0",
    "platformAdAccountId": "673c621a82c88059710de3fd",
    "name": "Acme"
  },
  "budget": {
    "raw": "string"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Ad accounts

| Event | When it fires |
| --- | --- |
| [`ad_account.status_changed`](#ad-account-status-changed) | Ad account status changed. |

### ad_account.status_changed

Ad account status changed.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "ad_account.status_changed",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "adAccount": {
    "platformAdAccountId": "673c621a82c88059710de3fd",
    "name": "Acme"
  },
  "status": {
    "previous": "active",
    "current": "active",
    "raw": "string"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Ad rules

| Event | When it fires |
| --- | --- |
| [`ad_rule.triggered`](#ad-rule-triggered) | Ad rule triggered. |

### ad_rule.triggered

Ad rule triggered.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "ad_rule.triggered",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "instagram",
    "username": "acme",
    "displayName": "Acme"
  },
  "rule": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "level": "campaign",
    "platformAdAccountId": "673c621a82c88059710de3fd"
  },
  "run": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "ranAt": "2026-10-02T09:00:00.000Z",
    "today": "2026-10-01",
    "timezone": "America/New_York",
    "timezoneAssumed": true,
    "currency": "USD"
  },
  "objects": [
    {
      "platformId": "648aa9da2e1bf42f668d6ef0",
      "name": "Acme",
      "platformCampaignId": "68f1e8569b986839e821d8ba",
      "conditions": [
        {
          "metric": "string",
          "window": "string",
          "op": ">",
          "value": 12.5,
          "actual": 12.5
        }
      ],
      "actions": [
        {
          "type": "pause",
          "status": "done",
          "reason": "string",
          "previousDailyBudget": 12.5,
          "newDailyBudget": 12.5
        }
      ]
    }
  ],
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## WhatsApp

| Event | When it fires |
| --- | --- |
| [`whatsapp.template.status_updated`](#whatsapp-template-status-updated) | WhatsApp template status updated. |
| [`whatsapp.template.category_updated`](#whatsapp-template-category-updated) | WhatsApp template category updated. |
| [`whatsapp.account.quality_updated`](#whatsapp-account-quality-updated) | WhatsApp quality rating or messaging limit changed. |
| [`whatsapp.account.status_updated`](#whatsapp-account-status-updated) | WhatsApp Business Account restricted or reinstated. |
| [`whatsapp.account.alert_received`](#whatsapp-account-alert-received) | WhatsApp account alert received. |
| [`whatsapp.contact.identity_changed`](#whatsapp-contact-identity-changed) | WhatsApp contact identity changed. |
| [`whatsapp.account.name_status_updated`](#whatsapp-account-name-status-updated) | WhatsApp display-name review outcome. |
| [`whatsapp.automatic_event`](#whatsapp-automatic-event) | WhatsApp automatic event detected. |
| [`whatsapp.number.activated`](#whatsapp-number-activated) | WhatsApp number activated. |
| [`whatsapp.number.declined`](#whatsapp-number-declined) | WhatsApp number declined. |
| [`whatsapp.number.action_required`](#whatsapp-number-action-required) | WhatsApp number action required. |
| [`whatsapp.number.verification_required`](#whatsapp-number-verification-required) | WhatsApp number verification-required. |
| [`whatsapp.number.suspended`](#whatsapp-number-suspended) | WhatsApp number suspended. |
| [`whatsapp.number.reactivated`](#whatsapp-number-reactivated) | WhatsApp number reactivated. |
| [`whatsapp.number.released`](#whatsapp-number-released) | WhatsApp number released. |
| [`whatsapp.number.kyc_submitted`](#whatsapp-number-kyc-submitted) | WhatsApp number KYC submitted. |

### whatsapp.template.status_updated

WhatsApp template status updated.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "whatsapp.template.status_updated",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "whatsapp",
    "username": "acme",
    "displayName": "Acme"
  },
  "template": {
    "templateId": "68fc85b3d7dcabf758aa29d2",
    "name": "Acme",
    "language": "en",
    "status": "APPROVED",
    "reason": "string"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### whatsapp.template.category_updated

WhatsApp template category updated.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "whatsapp.template.category_updated",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "whatsapp",
    "username": "acme",
    "displayName": "Acme"
  },
  "template": {
    "templateId": "68fc85b3d7dcabf758aa29d2",
    "name": "Acme",
    "language": "en",
    "changeType": "scheduled",
    "category": "UTILITY",
    "previousCategory": "UTILITY",
    "scheduledCategory": "UTILITY",
    "effectiveAt": "2026-10-02T09:00:00.000Z"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### whatsapp.account.quality_updated

WhatsApp quality rating or messaging limit changed.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "whatsapp.account.quality_updated",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "whatsapp",
    "username": "acme",
    "displayName": "Acme"
  },
  "quality": {
    "source": "phone_number_quality_update",
    "metaEvent": "string",
    "qualityRating": "string",
    "previousQualityRating": "string",
    "messagingLimitTier": "string",
    "previousMessagingLimitTier": "string",
    "displayPhoneNumber": "+14155550123"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### whatsapp.account.status_updated

WhatsApp Business Account restricted or reinstated.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "whatsapp.account.status_updated",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "whatsapp",
    "username": "acme",
    "displayName": "Acme"
  },
  "status": {
    "status": "restricted",
    "metaEvent": "string",
    "reason": "string",
    "violationType": "string",
    "restrictions": [
      {
        "type": "string",
        "expiresAt": "2026-10-02T09:00:00.000Z"
      }
    ],
    "banState": "string",
    "banDate": "string"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### whatsapp.account.alert_received

WhatsApp account alert received.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "whatsapp.account.alert_received",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "whatsapp",
    "username": "acme",
    "displayName": "Acme"
  },
  "alert": {
    "entityType": "string",
    "entityId": "64cbb67ef00cda43b51f2305",
    "severity": "string",
    "status": "active",
    "type": "string",
    "description": "A short description"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### whatsapp.contact.identity_changed

WhatsApp contact identity changed.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "whatsapp.contact.identity_changed",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "whatsapp",
    "username": "acme",
    "displayName": "Acme"
  },
  "reason": "user_changed_number",
  "previous": {
    "phoneNumber": "+14155550123",
    "businessScopedUserId": "61f84cc05876a1c25c483817",
    "parentBusinessScopedUserId": "66ba6a8970cf071a451ae422",
    "whatsappUsername": "acme"
  },
  "current": {
    "phoneNumber": "+14155550123",
    "businessScopedUserId": "61f84cc05876a1c25c483817",
    "parentBusinessScopedUserId": "66ba6a8970cf071a451ae422",
    "whatsappUsername": "acme"
  },
  "contactId": "642d31f43531ce7d44aa5013",
  "conversationId": "6e525f3820fc636aa96d2ee9",
  "changedAt": "2026-10-02T09:00:00.000Z",
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### whatsapp.account.name_status_updated

WhatsApp display-name review outcome.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "whatsapp.account.name_status_updated",
  "account": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "platform": "whatsapp",
    "username": "acme",
    "displayName": "Acme"
  },
  "name": {
    "status": "APPROVED",
    "requestedName": "Acme",
    "rejectionReason": "string",
    "displayPhoneNumber": "+14155550123"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### whatsapp.automatic_event

WhatsApp automatic event detected.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "whatsapp.automatic_event",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "accountId": "696e0b682d0a31188e7a2ba9",
  "conversationId": "6e525f3820fc636aa96d2ee9",
  "platformMessageId": "6d02da82d3a496146d890d30",
  "eventName": "Acme",
  "ctwaClid": "6a5583ad035650611dce66f3",
  "customData": {
    "currency": "USD",
    "value": 12.5
  },
  "detectedAt": "2026-10-02T09:00:00.000Z"
}
```

### whatsapp.number.activated

WhatsApp number activated.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "whatsapp.number.activated",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "number": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "phoneNumber": "+14155550123",
    "country": "US",
    "profileId": "6a0b6573846efc28aaa9a3ff"
  }
}
```

### whatsapp.number.declined

WhatsApp number declined.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "whatsapp.number.declined",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "number": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "phoneNumber": "+14155550123",
    "country": "US",
    "profileId": "6a0b6573846efc28aaa9a3ff"
  },
  "reason": "string"
}
```

### whatsapp.number.action_required

WhatsApp number action required.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "whatsapp.number.action_required",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "reason": "string",
  "requirements": [
    {
      "requirementId": "6296509a322aab288a61cc5d",
      "label": "string",
      "status": "approved"
    }
  ],
  "reviewedAt": "2026-10-02T09:00:00.000Z",
  "number": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "phoneNumber": "+14155550123",
    "country": "US",
    "profileId": "6a0b6573846efc28aaa9a3ff"
  }
}
```

### whatsapp.number.verification_required

WhatsApp number verification-required.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "whatsapp.number.verification_required",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "number": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "phoneNumber": "+14155550123",
    "country": "US",
    "profileId": "6a0b6573846efc28aaa9a3ff"
  },
  "verificationUrl": "https://pozy.ai/media/example-1.jpg"
}
```

### whatsapp.number.suspended

WhatsApp number suspended.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "whatsapp.number.suspended",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "number": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "phoneNumber": "+14155550123",
    "country": "US",
    "profileId": "6a0b6573846efc28aaa9a3ff"
  },
  "reason": "string"
}
```

### whatsapp.number.reactivated

WhatsApp number reactivated.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "whatsapp.number.reactivated",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "number": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "phoneNumber": "+14155550123",
    "country": "US",
    "profileId": "6a0b6573846efc28aaa9a3ff"
  }
}
```

### whatsapp.number.released

WhatsApp number released.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "whatsapp.number.released",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "number": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "phoneNumber": "+14155550123",
    "country": "US",
    "profileId": "6a0b6573846efc28aaa9a3ff"
  },
  "reason": "string"
}
```

### whatsapp.number.kyc_submitted

WhatsApp number KYC submitted.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "whatsapp.number.kyc_submitted",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "number": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "phoneNumber": "+14155550123",
    "country": "US",
    "profileId": "6a0b6573846efc28aaa9a3ff"
  }
}
```

## Phone numbers

| Event | When it fires |
| --- | --- |
| [`phone_number.stock_available`](#phone-number-stock-available) | Phone-number stock available. |

### phone_number.stock_available

Phone-number stock available.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "test": false,
  "event": "phone_number.stock_available",
  "stock": {
    "country": "US",
    "types": [
      {
        "numberType": "string",
        "availableCount": 42
      }
    ],
    "areaCode": "string",
    "areaName": "Acme"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Verification

| Event | When it fires |
| --- | --- |
| [`verification.approved`](#verification-approved) | Verification approved. |
| [`verification.failed`](#verification-failed) | Verification failed. |

### verification.approved

Verification approved.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "event": "verification.approved",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "verification": {
    "verificationId": "6e85def772268339137ee9ed",
    "channel": "sms",
    "to": "+14155550123"
  }
}
```

### verification.failed

Verification failed.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "event": "verification.failed",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "verification": {
    "verificationId": "6e85def772268339137ee9ed",
    "channel": "sms",
    "to": "+14155550123"
  },
  "reason": "max_attempts_reached"
}
```

## Commerce

| Event | When it fires |
| --- | --- |
| [`commerce.product.created`](#commerce-product-created) | Commerce product created. |
| [`commerce.product.updated`](#commerce-product-updated) | Commerce product updated. |
| [`commerce.product.deleted`](#commerce-product-deleted) | Commerce product deleted. |
| [`commerce.order.created`](#commerce-order-created) | Commerce order created. |
| [`commerce.order.updated`](#commerce-order-updated) | Commerce order updated. |
| [`commerce.order.refunded`](#commerce-order-refunded) | Commerce order refunded. |

### commerce.product.created

Commerce product created.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "event": "commerce.product.created",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "store": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "shopify",
    "shopId": "6bd1a19df3411510be342018"
  },
  "resource": {
    "type": "product",
    "id": "6bfebd43ddc270f6d2c56fc5",
    "status": "active",
    "platformStatus": "instagram"
  }
}
```

### commerce.product.updated

Commerce product updated.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "event": "commerce.product.updated",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "store": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "shopify",
    "shopId": "6bd1a19df3411510be342018"
  },
  "resource": {
    "type": "product",
    "id": "6bfebd43ddc270f6d2c56fc5",
    "status": "active",
    "platformStatus": "instagram"
  }
}
```

### commerce.product.deleted

Commerce product deleted.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "event": "commerce.product.deleted",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "store": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "shopify",
    "shopId": "6bd1a19df3411510be342018"
  },
  "resource": {
    "type": "product",
    "id": "6bfebd43ddc270f6d2c56fc5",
    "status": "active",
    "platformStatus": "instagram"
  }
}
```

### commerce.order.created

Commerce order created.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "event": "commerce.order.created",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "store": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "shopify",
    "shopId": "6bd1a19df3411510be342018"
  },
  "resource": {
    "type": "order",
    "id": "6bfebd43ddc270f6d2c56fc5",
    "status": "pending_payment",
    "platformStatus": "instagram"
  }
}
```

### commerce.order.updated

Commerce order updated.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "event": "commerce.order.updated",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "store": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "shopify",
    "shopId": "6bd1a19df3411510be342018"
  },
  "resource": {
    "type": "order",
    "id": "6bfebd43ddc270f6d2c56fc5",
    "status": "pending_payment",
    "platformStatus": "instagram"
  }
}
```

### commerce.order.refunded

Commerce order refunded.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "event": "commerce.order.refunded",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "store": {
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "shopify",
    "shopId": "6bd1a19df3411510be342018"
  },
  "resource": {
    "type": "order",
    "id": "6bfebd43ddc270f6d2c56fc5",
    "status": "pending_payment",
    "platformStatus": "instagram"
  }
}
```

## SMS registration

| Event | When it fires |
| --- | --- |
| [`sms.registration.action_required`](#sms-registration-action-required) | SMS registration action required. |
| [`sms.registration.status_updated`](#sms-registration-status-updated) | SMS registration status updated. |

### sms.registration.action_required

SMS registration action required.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "sms.registration.action_required",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "registration": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "type": "standard_10dlc",
    "displayName": "Acme",
    "status": "active",
    "profileId": "6a0b6573846efc28aaa9a3ff"
  },
  "reason": "changes_requested",
  "message": "Hello from Pozy"
}
```

### sms.registration.status_updated

SMS registration status updated.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "sms.registration.status_updated",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "registration": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "type": "standard_10dlc",
    "displayName": "Acme",
    "status": "active",
    "profileId": "6a0b6573846efc28aaa9a3ff"
  },
  "status": "changes_requested",
  "reason": "string"
}
```

## Branded calling

| Event | When it fires |
| --- | --- |
| [`branded_calling.identity.status_updated`](#branded-calling-identity-status-updated) | Caller identity status updated. |
| [`branded_calling.identity.action_required`](#branded-calling-identity-action-required) | Caller identity action required. |
| [`branded_calling.number.status_updated`](#branded-calling-number-status-updated) | Branded number status updated. |

### branded_calling.identity.status_updated

Caller identity status updated.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "event": "branded_calling.identity.status_updated",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "identity": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "displayName": "Acme",
    "status": "active"
  },
  "status": "requested",
  "reason": "string"
}
```

### branded_calling.identity.action_required

Caller identity action required.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "event": "branded_calling.identity.action_required",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "identity": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "displayName": "Acme",
    "status": "active"
  },
  "reason": "changes_requested",
  "message": "Hello from Pozy"
}
```

### branded_calling.number.status_updated

Branded number status updated.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "event": "branded_calling.number.status_updated",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "identity": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "displayName": "Acme"
  },
  "number": {
    "phoneNumberId": "698fba0989716df44adb771f",
    "phoneNumber": "+14155550123",
    "status": "submitted"
  },
  "reason": "string"
}
```

## Rcs

| Event | When it fires |
| --- | --- |
| [`rcs.agent.status_updated`](#rcs-agent-status-updated) | RCS agent status updated. |

### rcs.agent.status_updated

RCS agent status updated.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "rcs.agent.status_updated",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "agent": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "displayName": "Acme",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "accountId": "696e0b682d0a31188e7a2ba9"
  },
  "status": "changes_requested",
  "reason": "string"
}
```

## Api

| Event | When it fires |
| --- | --- |
| [`api.changelog.published`](#api-changelog-published) | API changelog entry published. |

### api.changelog.published

API changelog entry published.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "test": false,
  "event": "api.changelog.published",
  "entry": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "type": "new_feature",
    "impact": "none",
    "platforms": [
      "instagram"
    ],
    "title": "Launch day",
    "summary": "string",
    "message": "Hello from Pozy",
    "publishedAt": "2026-10-02T09:00:00.000Z",
    "specVersion": "string",
    "url": "https://pozy.ai/media/example-1.jpg",
    "changes": {
      "endpoints": {
        "added": [
          {
            "method": "string",
            "path": "string",
            "operationId": "67862eb877261ce93b8e9e39",
            "tags": [
              "string"
            ],
            "xPlatforms": [
              "instagram"
            ]
          }
        ],
        "removed": [
          {
            "method": "string",
            "path": "string",
            "operationId": "67862eb877261ce93b8e9e39",
            "tags": [
              "string"
            ],
            "xPlatforms": [
              "instagram"
            ]
          }
        ],
        "modified": [
          {
            "method": "string",
            "path": "string",
            "operationId": "67862eb877261ce93b8e9e39",
            "tags": [
              "string"
            ],
            "xPlatforms": [
              "instagram"
            ]
          }
        ]
      },
      "schemas": {
        "added": [
          "string"
        ],
        "removed": [
          "string"
        ],
        "modified": [
          "string"
        ]
      }
    }
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Sequences

| Event | When it fires |
| --- | --- |
| [`sequence.enrolled`](#sequence-enrolled) | Sequence enrolled. |
| [`sequence.exited`](#sequence-exited) | Sequence exited. |

### sequence.enrolled

Sequence enrolled.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "sequence.enrolled",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "sequence": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme"
  },
  "contact": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "enrollment": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "exitReason": "completed"
}
```

### sequence.exited

Sequence exited.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "sequence.exited",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "sequence": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme"
  },
  "contact": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "enrollment": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "exitReason": "completed"
}
```

## Workflows

| Event | When it fires |
| --- | --- |
| [`workflow.run.started`](#workflow-run-started) | Workflow run started. |
| [`workflow.run.completed`](#workflow-run-completed) | Workflow run completed. |
| [`workflow.run.failed`](#workflow-run-failed) | Workflow run failed. |

### workflow.run.started

Workflow run started.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "workflow.run.started",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "workflow": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme"
  },
  "execution": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "status": "running"
  },
  "conversation": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "contact": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "trigger": {
    "type": "string",
    "text": "Hello from Pozy"
  },
  "error": "string"
}
```

### workflow.run.completed

Workflow run completed.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "workflow.run.completed",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "workflow": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme"
  },
  "execution": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "status": "running"
  },
  "conversation": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "contact": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "trigger": {
    "type": "string",
    "text": "Hello from Pozy"
  },
  "error": "string"
}
```

### workflow.run.failed

Workflow run failed.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "event": "workflow.run.failed",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "workflow": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme"
  },
  "execution": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "status": "running"
  },
  "conversation": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "contact": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "trigger": {
    "type": "string",
    "text": "Hello from Pozy"
  },
  "error": "string"
}
```

## Support

| Event | When it fires |
| --- | --- |
| [`support.run.completed`](#support-run-completed) | Support Assistant finished. |
| [`support.run.failed`](#support-run-failed) | Support Assistant failed. |

### support.run.completed

Support Assistant finished.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "event": "support.run.completed",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "run": {
    "runId": "6e3431a916a6bb08fe30481d",
    "threadId": "60186572e25ff711298bf12e",
    "status": "queued",
    "stopReason": "answered",
    "question": "string",
    "answer": "string",
    "diagnosis": {
      "category": "account_connection",
      "cause": "string",
      "fixSteps": [
        "string"
      ],
      "docsLinks": [
        "string"
      ],
      "whoMustAct": "integrator"
    },
    "usage": {
      "inputTokens": 1,
      "outputTokens": 1,
      "cacheReadTokens": 1,
      "cacheWriteTokens": 1
    },
    "costUsd": 12.5,
    "maxCostUsd": 12.5,
    "createdAt": "2026-10-02T09:00:00.000Z",
    "startedAt": "2026-10-02T09:00:00.000Z",
    "finishedAt": "2026-10-02T09:00:00.000Z",
    "supportTicket": {
      "openedAt": "2026-10-02T09:00:00.000Z"
    },
    "pollAfterSeconds": 1
  }
}
```

### support.run.failed

Support Assistant failed.

**Example payload**

```json
{
  "test": false,
  "id": "evt_8a1f4c2e9b7d3a60",
  "event": "support.run.failed",
  "timestamp": "2026-10-30T09:15:00.000Z",
  "run": {
    "runId": "6e3431a916a6bb08fe30481d",
    "threadId": "60186572e25ff711298bf12e",
    "status": "queued",
    "stopReason": "answered",
    "question": "string",
    "answer": "string",
    "diagnosis": {
      "category": "account_connection",
      "cause": "string",
      "fixSteps": [
        "string"
      ],
      "docsLinks": [
        "string"
      ],
      "whoMustAct": "integrator"
    },
    "usage": {
      "inputTokens": 1,
      "outputTokens": 1,
      "cacheReadTokens": 1,
      "cacheWriteTokens": 1
    },
    "costUsd": 12.5,
    "maxCostUsd": 12.5,
    "createdAt": "2026-10-02T09:00:00.000Z",
    "startedAt": "2026-10-02T09:00:00.000Z",
    "finishedAt": "2026-10-02T09:00:00.000Z",
    "supportTicket": {
      "openedAt": "2026-10-02T09:00:00.000Z"
    },
    "pollAfterSeconds": 1
  }
}
```

## Campaign submission

| Event | When it fires |
| --- | --- |
| [`campaign_submission.received`](#campaign-submission-received) | Campaign submission received. |
| [`campaign_submission.flagged`](#campaign-submission-flagged) | Campaign submission flagged. |
| [`campaign_submission.pending_review`](#campaign-submission-pending-review) | Campaign submission pending review. |
| [`campaign_submission.approved`](#campaign-submission-approved) | Campaign submission approved. |
| [`campaign_submission.rejected`](#campaign-submission-rejected) | Campaign submission rejected. |

### campaign_submission.received

Campaign submission received.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "campaign_submission.received",
  "campaign": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme"
  },
  "participant": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "creator": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "displayName": "Acme"
  },
  "submission": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "instagram",
    "platformPostId": "637f799b3039e6602e83fa4f",
    "platformPostUrl": "https://pozy.ai/media/example-1.jpg",
    "status": "active",
    "viewsAtSubmission": 1,
    "flags": [
      {
        "code": "string",
        "detail": "string"
      }
    ]
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### campaign_submission.flagged

Campaign submission flagged.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "campaign_submission.flagged",
  "campaign": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme"
  },
  "participant": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "creator": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "displayName": "Acme"
  },
  "submission": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "instagram",
    "platformPostId": "637f799b3039e6602e83fa4f",
    "platformPostUrl": "https://pozy.ai/media/example-1.jpg",
    "status": "active",
    "viewsAtSubmission": 1,
    "flags": [
      {
        "code": "string",
        "detail": "string"
      }
    ]
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### campaign_submission.pending_review

Campaign submission pending review.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "campaign_submission.pending_review",
  "campaign": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme"
  },
  "participant": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "creator": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "displayName": "Acme"
  },
  "submission": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "instagram",
    "platformPostId": "637f799b3039e6602e83fa4f",
    "platformPostUrl": "https://pozy.ai/media/example-1.jpg",
    "status": "active",
    "viewsAtSubmission": 1,
    "flags": [
      {
        "code": "string",
        "detail": "string"
      }
    ]
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### campaign_submission.approved

Campaign submission approved.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "campaign_submission.approved",
  "campaign": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme"
  },
  "participant": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "creator": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "displayName": "Acme"
  },
  "submission": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "instagram",
    "platformPostId": "637f799b3039e6602e83fa4f",
    "platformPostUrl": "https://pozy.ai/media/example-1.jpg",
    "status": "active",
    "viewsAtSubmission": 1,
    "flags": [
      {
        "code": "string",
        "detail": "string"
      }
    ]
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### campaign_submission.rejected

Campaign submission rejected.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "campaign_submission.rejected",
  "campaign": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme"
  },
  "participant": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "creator": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "displayName": "Acme"
  },
  "submission": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "instagram",
    "platformPostId": "637f799b3039e6602e83fa4f",
    "platformPostUrl": "https://pozy.ai/media/example-1.jpg",
    "status": "active",
    "viewsAtSubmission": 1,
    "flags": [
      {
        "code": "string",
        "detail": "string"
      }
    ]
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Creator campaigns

| Event | When it fires |
| --- | --- |
| [`creator_campaign.closed`](#creator-campaign-closed) | Creator campaign closed. |
| [`creator_campaign.budget_exhausted`](#creator-campaign-budget-exhausted) | Creator campaign budget exhausted. |

### creator_campaign.closed

Creator campaign closed.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "creator_campaign.closed",
  "campaign": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "budgetCents": 1,
    "budgetExhaustedAt": "2026-10-02T09:00:00.000Z",
    "closedAt": "2026-10-02T09:00:00.000Z"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### creator_campaign.budget_exhausted

Creator campaign budget exhausted.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "creator_campaign.budget_exhausted",
  "campaign": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "budgetCents": 1,
    "budgetExhaustedAt": "2026-10-02T09:00:00.000Z",
    "closedAt": "2026-10-02T09:00:00.000Z"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Campaign payout

| Event | When it fires |
| --- | --- |
| [`campaign_payout.payable`](#campaign-payout-payable) | Campaign payout payable. |
| [`campaign_payout.settled`](#campaign-payout-settled) | Campaign payout settled. |
| [`campaign_payout.failed`](#campaign-payout-failed) | Campaign payout failed. |

### campaign_payout.payable

Campaign payout payable.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "campaign_payout.payable",
  "campaign": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "settlement": "none"
  },
  "participant": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "creator": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "displayName": "Acme"
  },
  "payout": {
    "payableCents": 1,
    "settlement": {
      "entryId": "6a385c12fc97ebd038aaca0f",
      "amountCents": 1,
      "externalReference": "string",
      "recorded": true,
      "transferId": "6f5f6fe5901ca25e11c24ddb",
      "feeCents": 1,
      "totalCents": 42
    },
    "failure": {
      "transferId": "6f5f6fe5901ca25e11c24ddb",
      "amountCents": 1,
      "reason": "returned"
    }
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### campaign_payout.settled

Campaign payout settled.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "campaign_payout.settled",
  "campaign": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "settlement": "none"
  },
  "participant": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "creator": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "displayName": "Acme"
  },
  "payout": {
    "payableCents": 1,
    "settlement": {
      "entryId": "6a385c12fc97ebd038aaca0f",
      "amountCents": 1,
      "externalReference": "string",
      "recorded": true,
      "transferId": "6f5f6fe5901ca25e11c24ddb",
      "feeCents": 1,
      "totalCents": 42
    },
    "failure": {
      "transferId": "6f5f6fe5901ca25e11c24ddb",
      "amountCents": 1,
      "reason": "returned"
    }
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### campaign_payout.failed

Campaign payout failed.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "campaign_payout.failed",
  "campaign": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "settlement": "none"
  },
  "participant": {
    "id": "6bfebd43ddc270f6d2c56fc5"
  },
  "creator": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "displayName": "Acme"
  },
  "payout": {
    "payableCents": 1,
    "settlement": {
      "entryId": "6a385c12fc97ebd038aaca0f",
      "amountCents": 1,
      "externalReference": "string",
      "recorded": true,
      "transferId": "6f5f6fe5901ca25e11c24ddb",
      "feeCents": 1,
      "totalCents": 42
    },
    "failure": {
      "transferId": "6f5f6fe5901ca25e11c24ddb",
      "amountCents": 1,
      "reason": "returned"
    }
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Campaign participant

| Event | When it fires |
| --- | --- |
| [`campaign_participant.joined`](#campaign-participant-joined) | Campaign participant joined. |
| [`campaign_participant.suspended`](#campaign-participant-suspended) | Campaign participant suspended. |
| [`campaign_participant.removed`](#campaign-participant-removed) | Campaign participant removed. |

### campaign_participant.joined

Campaign participant joined.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "campaign_participant.joined",
  "campaign": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme"
  },
  "participant": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "status": "invited",
    "joinedAt": "2026-10-02T09:00:00.000Z"
  },
  "creator": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "displayName": "Acme"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### campaign_participant.suspended

Campaign participant suspended.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "campaign_participant.suspended",
  "campaign": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme"
  },
  "participant": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "status": "invited",
    "joinedAt": "2026-10-02T09:00:00.000Z"
  },
  "creator": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "displayName": "Acme"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

### campaign_participant.removed

Campaign participant removed.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "profiles": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "externalId": "62c9d6bdf3fa891362623a67"
    }
  ],
  "test": false,
  "event": "campaign_participant.removed",
  "campaign": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme"
  },
  "participant": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "status": "invited",
    "joinedAt": "2026-10-02T09:00:00.000Z"
  },
  "creator": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "displayName": "Acme"
  },
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```

## Webhook

| Event | When it fires |
| --- | --- |
| [`webhook.test`](#webhook-test) | Webhook test. |

### webhook.test

Webhook test.

**Example payload**

```json
{
  "id": "evt_8a1f4c2e9b7d3a60",
  "event": "webhook.test",
  "message": "Hello from Pozy",
  "timestamp": "2026-10-30T09:15:00.000Z"
}
```