---
title: "Create a Webhook"
method: POST
path: "/webhooks"
tags: ["Webhooks"]
---

# Create a Webhook

`POST /webhooks`

## Request

- Base URL: `https://sandbox.au-0000.api.assemblypay.com`
- URL: `https://sandbox.au-0000.api.assemblypay.com/webhooks`
- Auth: HTTP bearer

Create a **Webhook** to notify you at the `URL` when the `object_type` changes

## Request body

- WebhookRequestBody
  - `url` string, required: URL to which the webhook will notify
  - `object_type` 'batch_transactions' | 'accounts' | 'addresses' | 'companies' | 'items' | 'disbursements' | 'users' | 'transactions' | 'virtual_accounts' | 'pay_ids' | 'verifications' | 'payto_agreements', required: Object or entity to which the webhook refer. Please refer to [Webhook](https://developer.assemblypayments.com/docs/callbacks) for a list of object types.
  - `description` string: Description to identify the webhook

## Response `201`

Created

- Webhook
  - `uuid` string, uuid
  - `object_type` string
  - `http_method` string
  - `url` string
  - `description` string
  - `enabled` string
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `links` WebhookLinks
    - `self` string
    - `webhooks` string

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `409`: Conflict
- `422`: Unprocessable entity
- `500`: Internal Server error

---

[API](https://skmtc.dev/hellozai/apis/webhooks-api.md) - [All operations](https://skmtc.dev/hellozai/apis/webhooks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hellozai/apis/webhooks-api/revisions/94791cdd7a23?raw)