Create a new webhook configuration

POST 
/config

Create a new webhook configuration

Request

application/json

Body

required

id string
The unique identifier of the webhook
Example: 123e4567-e89b-12d3-a456-426614174000
name stringrequired
The name of the webhook configuration
Example: Order Created Webhook
ownerId stringrequired
The ID of the owner (organization)
Example: org_12345
subscribedEvents string[]required
List of events the webhook is subscribed to
Possible values: [ORDER_EVENT, PARCEL_EVENT, UNKNOWN]
Example: ["ORDER_CREATED","ORDER_SHIPPED"]

dispatchConfig

object

required

oneOf

MailConfigDTO

type stringrequired

The type of dispatcher configuration

Possible values: [mailConfig]

Example: mailConfig

email emailrequired

The email address to send notifications to

Example: user@example.com

RestConfigDTO

type stringrequired

The type of dispatcher configuration

Possible values: [restConfig]

Example: restConfig

endpoint urirequired

The REST API endpoint URL

Example: https://api.example.com/webhook
status string
The status of the webhook
Possible values: [ACTIVE, INACTIVE]
Example: ACTIVE

Responses

200

Webhook configuration created successfully

application/json

Schema

Schema

id string
The unique identifier of the webhook
Example: 123e4567-e89b-12d3-a456-426614174000
name stringrequired
The name of the webhook configuration
Example: Order Created Webhook
ownerId stringrequired
The ID of the owner (organization)
Example: org_12345
subscribedEvents string[]required
List of events the webhook is subscribed to
Possible values: [ORDER_EVENT, PARCEL_EVENT, UNKNOWN]
Example: ["ORDER_CREATED","ORDER_SHIPPED"]

dispatchConfig

object

required

oneOf

MailConfigDTO

type stringrequired

The type of dispatcher configuration

Possible values: [mailConfig]

Example: mailConfig

email emailrequired

The email address to send notifications to

Example: user@example.com

RestConfigDTO

type stringrequired

The type of dispatcher configuration

Possible values: [restConfig]

Example: restConfig

endpoint urirequired

The REST API endpoint URL

Example: https://api.example.com/webhook
status string
The status of the webhook
Possible values: [ACTIVE, INACTIVE]
Example: ACTIVE

Example (from schema)

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Order Created Webhook",
  "ownerId": "org_12345",
  "subscribedEvents": [
    "ORDER_CREATED",
    "ORDER_SHIPPED"
  ],
  "dispatchConfig": {},
  "status": "ACTIVE"
}

500

Internal server error

Loading...