List webhook event types

GET

/v1/webhook-event-types

curl --request GET \
  --url https://api.inboxcnx.com/v1/webhook-event-types \
  --header 'Authorization: Bearer <token>'

Lists every event type a webhook endpoint can subscribe to, with what it means, so a client never keeps its own copy of the catalogue.

Requires the write:webhooks scope.

Authorizations

• apiKey

Responses

200

The catalogue, one entry per type

Media typeapplication/json

object

data

required

Array<object>

object

type

required

string

description

required

string

Example

{
  "data": [
    {
      "type": "message.deleted",
      "description": "The provider deleted a delivered mail."
    }
  ]
}

403

The credential lacks the write:webhooks scope

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}