---
title: "Create a Webhook Event"
method: POST
path: "/v1/webhook-events"
---

# Create a Webhook Event

`POST /v1/webhook-events`

This endpoint allows you to create a webhook event. The webhook event will listen to the event types that you specify and send a POST request to the URL that you specify.

## Headers

- `X-BUSINESS-API-KEY` string, required

## Request body

- object
  - `name` string, required — The name of the webhook event.
  - `url` string, uri, required — The URL of the webhook, must be a valid URL with `https` protocol
  - `event_types` string[], required — The event types that the webhook will listen to. The available events: charge.created, charge.updated, payout.created, order.created, order.updated, invoice.created, transfer.created, transfer.updated

## Response `201`

201

- object
  - `id` string, required
  - `business_id` string, required
  - `name` string, required
  - `url` string, required
  - `event_types` string[], required
  - `created_at` string, required
  - `updated_at` string, required

---

[API](https://skmtc.net/hitpayapp/apis/hitpay-api.md) · [All operations](https://skmtc.net/hitpayapp/apis/hitpay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hitpayapp/hitpay-api/revisions/6aae1a736990/schema)