---
title: "Send test webhook payloads"
method: POST
path: "/webhooks/tryout"
tags: ["Webhooks"]
---

# Send test webhook payloads

`POST /webhooks/tryout`

This endpoint let you try webhook configurations by sending test payloads.     This currently supports only one webhook configuration per request, entries after the first one will be ignored.       Payloads are created by the latest data of the specified event type, or if not available a default payload will be sent.       The request is similar to a regular webhook, but also contains an additional `X-Partoo-Webhook-Tryout` header.

## Query parameters

- `org_id` integer

## Request body

- CreateWebhooksPayload
  - `items` CreateWebhookPayloadItem[], required — The list of webhook configurations to create.
    - `url` string, required — The URL receiving the webhook's data. Only HTTPS URLs are supported.
    - `event_type` string, required — The webhook event type.
    - `custom_headers` CustomHeaders — Custom HTTP headers to include in webhook requests. Keys must start with `X-` (case-insensitive) and must not use the reserved `X-Partoo` prefix. Maximum 5 headers. Key max length: 128 characters. Value max length: 512 characters. The following characters are forbidden in header keys: space, `(`, `)`, `<`, `>`, `@`, `,`, `;`, `:`, `\`, `"`, `/`, `[`, `]`, `?`, `=`, `{`, `}`.

## Response `200`

OK

- object
  - `items` WebhookTryoutResult[] — Result of the tests.
    - `payload` object — The webhook sent payload. Varies depending on the event type.
    - `event_type` 'business_created' | 'business_updated' | 'business_deleted' | 'message_updated' | 'message_created' | 'lead_received' — The webhook event type.
    - `url` string — The URL receiving the webhook's data.
    - `status` 'success' | 'error' — Result status of the webhook tryout.

## Other responses

- `400` — Your request is incorrect
- `401` — You are not authenticated
- `403` — You are not allowed to perform this action

---

[API](https://skmtc.net/partoo/apis/partoo-rest-api.md) · [All operations](https://skmtc.net/partoo/apis/partoo-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/partoo/partoo-rest-api/versions/3652d8b1a8b3/schema)