---
title: "Sample webhook events"
method: GET
path: "/api/v1/events/sample"
tags: ["Webhooks"]
---

# Sample webhook events

`GET /api/v1/events/sample`

## Request

- Base URL: `https://mailinapp.com`
- URL: `https://mailinapp.com/api/v1/events/sample`
- Auth: HTTP bearer

Example deliveries, exactly as a subscription receives them, for field mapping before a real event has fired. One type with `type`, every type without.

## Query parameters

- `type` 'interaction.received' | 'form.submitted' | 'contact.created' | 'contact.updated' | 'lead.hot' | 'lead.new' | 'booking.created' | 'booking.cancelled' | 'deal.created' | 'deal.stage_changed' | 'purchase.completed' | 'journey.completed' | 'experiment.decided' | 'experiment.completed'

## Response `200`

Sample events

- object
  - `events` WebhookEvent[], required
    - `id` string, required
    - `type` 'interaction.received' | 'form.submitted' | 'contact.created' | 'contact.updated' | 'lead.hot' | 'lead.new' | 'booking.created' | 'booking.cancelled' | 'deal.created' | 'deal.stage_changed' | 'purchase.completed' | 'journey.completed' | 'experiment.decided' | 'experiment.completed', required
    - `createdAt` integer, required: Epoch ms.
    - `data` object, required

## Other responses

- `400`: Invalid request
- `401`: Missing or invalid API key
- `429`: Too many requests for this key

---

[API](https://skmtc.dev/mailinapp/apis/mailinapp-api.md) · [All operations](https://skmtc.dev/mailinapp/apis/mailinapp-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mailinapp/apis/mailinapp-api/revisions/61016f797884?raw)