Create a webhook

POST 
/openapi/2025-06/webhooks

Create a webhook with a unique identifier, notification URL, event name, and format.

Request

application/json

Body

Bodyrequired

webhook objectrequired

Webhook

addressstringrequired

Webhook notification URL, e.g. https://example.com/webhook

topicstringrequired

The topic of the webhook

Example

{
  "webhook": {
    "address": "string",
    "topic": "string"
  }
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

webhook object

Webhook

idstring

The unique identifier of the webhook

addressstring

Webhook notification URL, e.g. https://example.com/webhook

topicstring

The topic of the webhook

created_atstring

The time of the webhook was created

updated_atstring

The time of the webhook was updated

formatstring

The format of the webhook

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "webhook": {
      "id": "string",
      "address": "string",
      "topic": "string",
      "created_at": "string",
      "updated_at": "string",
      "format": "string"
    }
  }
}