List event types

GEThttps://api.checkslip.com/api/webhooks/event-types

API key

Lists every message type (event type) we can send to your system, such as slip.checked, sent when a transfer lookup with the bank finishes. subscribable false means you cannot subscribe to it yourself, such as webhook.test, which is sent only when you ask for a test message. Use the values in type as event_types when you create or update an endpoint. Needs an API key with webhook:read.

Parameters

Field	In	Type	Required
`traceparent`	header	`string`	no

Responses

200 `application/json`

Field	Type	Required
`items`	`EventTypeInfo[]`	yes
`items[].type`	`slip.checked \| webhook.test`	yes
`items[].description`	`string`	yes
`items[].subscribable`	`boolean`	yes

Possible errors

401

An error as Problem Details. All codes are listed at Error codes

curl https://api.checkslip.com/api/webhooks/event-types \
  -H "Authorization: Bearer $CHECKSLIP_API_KEY"

const res = await fetch("https://api.checkslip.com/api/webhooks/event-types", {
  headers: {
    Authorization: `Bearer ${process.env.CHECKSLIP_API_KEY}`,
  },
});
const data = await res.json();

import os

import requests

res = requests.get(
    "https://api.checkslip.com/api/webhooks/event-types",
    headers={
        "Authorization": f"Bearer {os.environ['CHECKSLIP_API_KEY']}",
    },
)
data = res.json()

Example response

{
  "items": [
    {
      "type": "slip.checked",
      "description": "string",
      "subscribable": true
    }
  ]
}

Parameters#

Responses#

200 application/json#

Possible errors#

Parameters

Responses

200 `application/json`

Possible errors