/api/v1/webhook-subscriptions (POST)

POST

/api/v1/webhook-subscriptions

curl --request POST \
  --url https://example.com/api/v1/webhook-subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "example", "eventTypes": [ "example" ], "description": "example" }'

Authorizations

• Bearer

Request Body^required

object

url

string

eventTypes

Array<string>

nullable

description

string

nullable

Example ^generated

{
  "url": "example",
  "eventTypes": [
    "example"
  ],
  "description": "example"
}

object

url

string

eventTypes

Array<string>

nullable

description

string

nullable

Example ^generated

{
  "url": "example",
  "eventTypes": [
    "example"
  ],
  "description": "example"
}

object

url

string

eventTypes

Array<string>

nullable

description

string

nullable

Example ^generated

{
  "url": "example",
  "eventTypes": [
    "example"
  ],
  "description": "example"
}

Responses

201

Created

object

id

required

string format: uuid

url

required

string

eventTypes

required

Array<string>

description

required

string

nullable

status

required

string

Allowed values: Active Inactive PendingDelete

secret

required

string

secretLastFour

required

string

consecutiveDeadLetters

required

integer format: int32

deactivationReason

required

string

nullable

deactivatedAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

object

id

required

string format: uuid

url

required

string

eventTypes

required

Array<string>

description

required

string

nullable

status

required

string

Allowed values: Active Inactive PendingDelete

secret

required

string

secretLastFour

required

string

consecutiveDeadLetters

required

integer format: int32

deactivationReason

required

string

nullable

deactivatedAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "status": "Active"
}

object

id

required

string format: uuid

url

required

string

eventTypes

required

Array<string>

description

required

string

nullable

status

required

string

Allowed values: Active Inactive PendingDelete

secret

required

string

secretLastFour

required

string

consecutiveDeadLetters

required

integer format: int32

deactivationReason

required

string

nullable

deactivatedAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "status": "Active"
}

400

Bad Request

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}