---
title: "Register webhook"
method: POST
path: "/3rdparty/v1/webhooks"
tags: ["User", "Webhooks"]
---

# Register webhook

`POST /3rdparty/v1/webhooks`

Registers webhook. If webhook with same ID already exists, it will be replaced

## Request body

- SmsgatewayWebhook
  - `deviceId` string — The unique identifier of the device the webhook is associated with.
  - `event` 'sms:received' | 'sms:data-received' | 'sms:sent' | 'sms:delivered' | 'sms:failed' | 'sms:cancelled' | 'system:ping' | 'mms:received' | 'mms:downloaded' | 'app:started' | 'sms:batch:received' | 'sms:batch:data-received' | 'mms:batch:received' | 'mms:batch:downloaded', required
  - `id` string — The unique identifier of the webhook.
  - `url` string, required — The URL the webhook will be sent to.

## Response `201`

Created

- SmsgatewayWebhook
  - `deviceId` string — The unique identifier of the device the webhook is associated with.
  - `event` 'sms:received' | 'sms:data-received' | 'sms:sent' | 'sms:delivered' | 'sms:failed' | 'sms:cancelled' | 'system:ping' | 'mms:received' | 'mms:downloaded' | 'app:started' | 'sms:batch:received' | 'sms:batch:data-received' | 'mms:batch:received' | 'mms:batch:downloaded', required
  - `id` string — The unique identifier of the webhook.
  - `url` string, required — The URL the webhook will be sent to.

## Other responses

- `400` — Invalid request
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal server error

---

[API](https://skmtc.dev/sms-gate/apis/smsgate-api.md) · [All operations](https://skmtc.dev/sms-gate/apis/smsgate-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/sms-gate/smsgate-api/revisions/56a6604029f1/schema)