List event types

GET

/webhooks/event-types

const url = 'https://api.clearance.rest/webhooks/event-types';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.clearance.rest/webhooks/event-types \
  --header 'X-API-Key: <X-API-Key>'

Catalog of subscribable event types. Opt-in types are only delivered when subscribed to by exact name.

Authorizations

ApiKeyAuth

Responses

200

Default Response

application/json

object

success

required

boolean

event_types

required

Array<object>

A subscribable event type.

object

type

required

string

description

required

string

opt_in

required

Opt-in types are delivered only when subscribed to by exact name.

boolean

Example

{
  "success": true
}

401

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}

403

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}