The event catalogue

GEThttps://api.norreach.app/v1/event-types

Every event a webhook endpoint can subscribe to, with the scope needed to receive it.

Any keyOperation id: list_event_types

GET/event-types

curl -X GET "https://api.norreach.app/v1/event-types" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

The event catalogue

{
  "object": "list",
  "data": [
    {
      "object": "event_type",
      "type": "lead.submitted",
      "scope": "pages:read",
      "resource": "lead",
      "description": "Someone filled in a form on a landing page."
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. Any valid key works. API keys and scopes

Response

200application/json— The event catalogue

object"list"required

dataobject[]required

Show child attributes

data[].object"event_type"required

data[].typestringrequired

data[].scopestring | nullrequired

data[].resourcestringrequired

data[].descriptionstringrequired

has_morefalserequired

next_cursornullrequired

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

GET/event-types

curl -X GET "https://api.norreach.app/v1/event-types" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

The event catalogue

{
  "object": "list",
  "data": [
    {
      "object": "event_type",
      "type": "lead.submitted",
      "scope": "pages:read",
      "resource": "lead",
      "description": "Someone filled in a form on a landing page."
    }
  ],
  "has_more": false,
  "next_cursor": null
}