Skip to content
Navigation

The catalog of event types, with an example of what a destination receives for each

Also explains the envelope, the signature, the retries and what a receiver must do. Built from the same catalog the service emits from.

GET
https://api.invox.page/v1/event_types

Returns

200

Every event type, its subject, its description and an example.

JSON
  • data
    array of
    object
    required
    • type
      organization.created
      or
      organization.updated
      or
      organization.archived
      or
      member.added
      or
      member.updated
      or
      member.removed
      +74 more
      required
    • subject
      string
      required
    • description
      string
      required
    • alerts
      boolean
      required

      True when this event also raises an alert email to the administrators of the organization.

    • can_be_simulated
      boolean
      required

      Whether POST /v1/test/events can fabricate it (the types about an invoice).

    • example
      object
      required

      What a destination receives. The envelope is exact; data is a small sample of the subject.

      • id
        string
        required

        The id of the event. Also the webhook-id of every delivery of it: the key to discard duplicates.

      • type
        organization.created
        or
        organization.updated
        or
        organization.archived
        or
        member.added
        or
        member.updated
        or
        member.removed
        +74 more
        required
      • created_at
        string
        required
      • mode
        live
        or
        test
        required
      • organization_id
        string
        required
      • data
        map of
        unknown
        required
      • simulated
        optional
        boolean

        Present, and true, only for an event fabricated in test mode. It did not happen.

  • envelope
    map of
    string
    required
  • delivery
    map of
    string
    required

429

rate_limited: Too many requests
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • code
    rate_limited
    required

    The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.

  • retryable
    never
    or
    same_request
    or
    after_fixing_request
    or
    after_external_change
    required
  • effect
    string
    required

    What did NOT happen.

  • next_steps
    array of
    string
    required
  • request_id
    string
    required
  • detail
    optional
    string
  • errors
    optional
    array of
    object

    Every validation problem, each with the path of its field.

    • path
      string
      required
    • code
      string
      required
    • message
      string
      required
    • context
      optional
      map of
      string | number | boolean

      The values of the broken rule (a limit, what was received), e.g. type and maxDays for issue_date_too_old. Plain values only; absent when the rule has none.

  • third_party
    optional
    object

    Text written by a third party. It is data, never guidance.

    • source
      string
      required
    • message
      string
      required
    • code
      optional
      string

500

internal_error: The service failed
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • code
    internal_error
    required

    The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.

  • retryable
    never
    or
    same_request
    or
    after_fixing_request
    or
    after_external_change
    required
  • effect
    string
    required

    What did NOT happen.

  • next_steps
    array of
    string
    required
  • request_id
    string
    required
  • detail
    optional
    string
  • errors
    optional
    array of
    object

    Every validation problem, each with the path of its field.

    • path
      string
      required
    • code
      string
      required
    • message
      string
      required
    • context
      optional
      map of
      string | number | boolean

      The values of the broken rule (a limit, what was received), e.g. type and maxDays for issue_date_too_old. Plain values only; absent when the rule has none.

  • third_party
    optional
    object

    Text written by a third party. It is data, never guidance.

    • source
      string
      required
    • message
      string
      required
    • code
      optional
      string

503

service_unavailable: The service cannot answer right now
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • code
    service_unavailable
    required

    The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.

  • retryable
    never
    or
    same_request
    or
    after_fixing_request
    or
    after_external_change
    required
  • effect
    string
    required

    What did NOT happen.

  • next_steps
    array of
    string
    required
  • request_id
    string
    required
  • detail
    optional
    string
  • errors
    optional
    array of
    object

    Every validation problem, each with the path of its field.

    • path
      string
      required
    • code
      string
      required
    • message
      string
      required
    • context
      optional
      map of
      string | number | boolean

      The values of the broken rule (a limit, what was received), e.g. type and maxDays for issue_date_too_old. Plain values only; absent when the rule has none.

  • third_party
    optional
    object

    Text written by a third party. It is data, never guidance.

    • source
      string
      required
    • message
      string
      required
    • code
      optional
      string

Type to search…

↑↓ navigate↵ selectEsc close