webhook

List event types

Lists the event types a webhook can subscribe to, with a description of each. Not paginated: has_more is always false.

get/event_type

Request

  • Base URL: http://localhost:3030
  • URL: http://localhost:3030/event_type
  • Auth: HTTP bearer

Response

A page of event types.

object'list' required

The object's type. Always list.

has_moreboolean required

Whether there are more results after this page.

next_cursorstring nullable required

The cursor for the next page. Send it as cursor. Null on the last page.

suppressedinteger required

The number of matching results withheld because the plan does not include them.

Example response

{
  "data": [
    {
      "name": "permit.created",
      "description": "A permit was filed on a place on a monitored list."
    }
  ],
  "next_cursor": "eyJrIjoiMjAyNi0xMC0wMSIsInQiOjQyfQ"
}

Changes

No recorded changes to this operation across all 1 revision of this API.