---
title: "The catalog of event types, with an example of what a destination receives for each"
description: "Also explains the envelope, the signature, the retries and what a receiver must do. Built from the same catalog the service emits from."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.invox.page/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Invox API › Events

`GET /v1/event_types`

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

## Code samples

### cURL

```bash
curl --request GET \
  --url https://api.invox.page/v1/event_types
```

### TypeScript

```typescript
const url = 'https://api.invox.page/v1/event_types';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.invox.page/v1/event_types"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

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

#### Example

```json
{
  "data": [
    {
      "type": "organization.created",
      "subject": "string",
      "description": "string",
      "alerts": true,
      "can_be_simulated": true,
      "example": {
        "id": "string",
        "type": "organization.created",
        "created_at": "string",
        "mode": "live",
        "organization_id": "string",
        "simulated": true,
        "data": {
          "property1": null,
          "property2": null
        }
      }
    }
  ],
  "envelope": {
    "property1": "string",
    "property2": "string"
  },
  "delivery": {
    "property1": "string",
    "property2": "string"
  }
}
```

- `data` (`get-event-types.response.200.data`; array<object>, required)
  - `type` (`get-event-types.response.200.data.type`; string, required)
    - one of `"organization.created"`, `"organization.updated"`, `"organization.archived"`, `"member.added"`, `"member.updated"`, `"member.removed"`, `"service_account.created"`, `"service_account.updated"`, `"service_account.disabled"`, `"api_key.created"`, `"api_key.revoked"`, `"issuer.created"`, `"issuer.updated"`, `"series.created"`, `"series.updated"`, `"invoice.created"`, `"invoice.sent"`, `"invoice.accepted"`, `"invoice.rejected"`, `"invoice.failed"`, `"invoice.stalled"`, `"invoice.held"`, `"invoice.released"`, `"production_access.requested"`, `"production_access.accepted"`, `"production_access.rejected"`, `"production_access.revoked"`, `"production_access.withdrawn"`, `"production_activation.submitted"`, `"production_activation.changes_requested"`, `"production_activation.resubmitted"`, `"production_activation.approved"`, `"production_activation.rejected"`, `"production_activation.withdrawn"`, `"production_activation.activated"`, `"establishment.created"`, `"establishment.updated"`, `"brand.updated"`, `"asset.uploaded"`, `"asset.removed"`, `"template.created"`, `"template.draft_saved"`, `"template.published"`, `"template.promoted"`, `"template.archived"`, `"invoice.pdf_ready"`, `"invoice.render_ready"`, `"file_share_link.created"`, `"file_share_link.revoked"`, `"issuer.ruc_verified"`, `"issuer.ruc_not_found"`, `"issuer.activated"`, `"provider_connection.created"`, `"provider_connection.updated"`, `"provider.account_blocked"`, `"provider.account_recovered"`, `"invoice.void_requested"`, `"invoice.voided"`, `"invoice.void_rejected"`, `"invoice.void_held"`, `"invoice.void_released"`, `"invoice.void_failed"`, `"invoice.void_stalled"`, `"invoice.reopened"`, `"invoice.externally_reversed"`, `"invoice.files_stored"`, `"invoice.file_failed"`, `"invoice.email_sent"`, `"invoice.email_not_sent"`, `"invoice.email_failed"`, `"invoice.email_held"`, `"webhook_endpoint.created"`, `"webhook_endpoint.updated"`, `"webhook_endpoint.deleted"`, `"webhook_endpoint.disabled"`, `"webhook_endpoint.secret_rotated"`, `"invitation.created"`, `"invitation.resent"`, `"invitation.accepted"`, `"invitation.revoked"`
  - `subject` (`get-event-types.response.200.data.subject`; string, required)
  - `description` (`get-event-types.response.200.data.description`; string, required)
  - `alerts` (`get-event-types.response.200.data.alerts`; boolean, required) — True when this event also raises an alert email to the administrators of the organization.
  - `can_be_simulated` (`get-event-types.response.200.data.can_be_simulated`; boolean, required) — Whether POST /v1/test/events can fabricate it (the types about an invoice).
  - `example` (`get-event-types.response.200.data.example`; object, required) — What a destination receives. The envelope is exact; `data` is a small sample of the subject.
    - `id` (`get-event-types.response.200.data.example.id`; string, required) — The id of the event. Also the `webhook-id` of every delivery of it: the key to discard duplicates.
    - `type` (`get-event-types.response.200.data.example.type`; string, required)
      - one of `"organization.created"`, `"organization.updated"`, `"organization.archived"`, `"member.added"`, `"member.updated"`, `"member.removed"`, `"service_account.created"`, `"service_account.updated"`, `"service_account.disabled"`, `"api_key.created"`, `"api_key.revoked"`, `"issuer.created"`, `"issuer.updated"`, `"series.created"`, `"series.updated"`, `"invoice.created"`, `"invoice.sent"`, `"invoice.accepted"`, `"invoice.rejected"`, `"invoice.failed"`, `"invoice.stalled"`, `"invoice.held"`, `"invoice.released"`, `"production_access.requested"`, `"production_access.accepted"`, `"production_access.rejected"`, `"production_access.revoked"`, `"production_access.withdrawn"`, `"production_activation.submitted"`, `"production_activation.changes_requested"`, `"production_activation.resubmitted"`, `"production_activation.approved"`, `"production_activation.rejected"`, `"production_activation.withdrawn"`, `"production_activation.activated"`, `"establishment.created"`, `"establishment.updated"`, `"brand.updated"`, `"asset.uploaded"`, `"asset.removed"`, `"template.created"`, `"template.draft_saved"`, `"template.published"`, `"template.promoted"`, `"template.archived"`, `"invoice.pdf_ready"`, `"invoice.render_ready"`, `"file_share_link.created"`, `"file_share_link.revoked"`, `"issuer.ruc_verified"`, `"issuer.ruc_not_found"`, `"issuer.activated"`, `"provider_connection.created"`, `"provider_connection.updated"`, `"provider.account_blocked"`, `"provider.account_recovered"`, `"invoice.void_requested"`, `"invoice.voided"`, `"invoice.void_rejected"`, `"invoice.void_held"`, `"invoice.void_released"`, `"invoice.void_failed"`, `"invoice.void_stalled"`, `"invoice.reopened"`, `"invoice.externally_reversed"`, `"invoice.files_stored"`, `"invoice.file_failed"`, `"invoice.email_sent"`, `"invoice.email_not_sent"`, `"invoice.email_failed"`, `"invoice.email_held"`, `"webhook_endpoint.created"`, `"webhook_endpoint.updated"`, `"webhook_endpoint.deleted"`, `"webhook_endpoint.disabled"`, `"webhook_endpoint.secret_rotated"`, `"invitation.created"`, `"invitation.resent"`, `"invitation.accepted"`, `"invitation.revoked"`
    - `created_at` (`get-event-types.response.200.data.example.created_at`; string, required)
    - `mode` (`get-event-types.response.200.data.example.mode`; string, required)
      - one of `"live"`, `"test"`
    - `organization_id` (`get-event-types.response.200.data.example.organization_id`; string, required)
    - `data` (`get-event-types.response.200.data.example.data`; map<unknown>, required)
    - `simulated` (`get-event-types.response.200.data.example.simulated`; boolean, optional) — Present, and `true`, only for an event fabricated in test mode. It did not happen.
- `envelope` (`get-event-types.response.200.envelope`; map<string>, required)
- `delivery` (`get-event-types.response.200.delivery`; map<string>, required)

### 429

`rate_limited`: Too many requests

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`get-event-types.response.429.type`; string, required)
  - format `uri`
- `title` (`get-event-types.response.429.title`; string, required)
- `status` (`get-event-types.response.429.status`; integer, required)
- `code` (`get-event-types.response.429.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"rate_limited"`
- `retryable` (`get-event-types.response.429.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`get-event-types.response.429.effect`; string, required) — What did NOT happen.
- `next_steps` (`get-event-types.response.429.next_steps`; array<string>, required)
- `request_id` (`get-event-types.response.429.request_id`; string, required)
- `detail` (`get-event-types.response.429.detail`; string, optional)
- `errors` (`get-event-types.response.429.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`get-event-types.response.429.errors.path`; string, required)
  - `code` (`get-event-types.response.429.errors.code`; string, required)
  - `message` (`get-event-types.response.429.errors.message`; string, required)
  - `context` (`get-event-types.response.429.errors.context`; map<string | number | boolean>, optional) — 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` (`get-event-types.response.429.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`get-event-types.response.429.third_party.source`; string, required)
  - `message` (`get-event-types.response.429.third_party.message`; string, required)
  - `code` (`get-event-types.response.429.third_party.code`; string, optional)

### 500

`internal_error`: The service failed

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`get-event-types.response.500.type`; string, required)
  - format `uri`
- `title` (`get-event-types.response.500.title`; string, required)
- `status` (`get-event-types.response.500.status`; integer, required)
- `code` (`get-event-types.response.500.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"internal_error"`
- `retryable` (`get-event-types.response.500.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`get-event-types.response.500.effect`; string, required) — What did NOT happen.
- `next_steps` (`get-event-types.response.500.next_steps`; array<string>, required)
- `request_id` (`get-event-types.response.500.request_id`; string, required)
- `detail` (`get-event-types.response.500.detail`; string, optional)
- `errors` (`get-event-types.response.500.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`get-event-types.response.500.errors.path`; string, required)
  - `code` (`get-event-types.response.500.errors.code`; string, required)
  - `message` (`get-event-types.response.500.errors.message`; string, required)
  - `context` (`get-event-types.response.500.errors.context`; map<string | number | boolean>, optional) — 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` (`get-event-types.response.500.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`get-event-types.response.500.third_party.source`; string, required)
  - `message` (`get-event-types.response.500.third_party.message`; string, required)
  - `code` (`get-event-types.response.500.third_party.code`; string, optional)

### 503

`service_unavailable`: The service cannot answer right now

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`get-event-types.response.503.type`; string, required)
  - format `uri`
- `title` (`get-event-types.response.503.title`; string, required)
- `status` (`get-event-types.response.503.status`; integer, required)
- `code` (`get-event-types.response.503.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"service_unavailable"`
- `retryable` (`get-event-types.response.503.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`get-event-types.response.503.effect`; string, required) — What did NOT happen.
- `next_steps` (`get-event-types.response.503.next_steps`; array<string>, required)
- `request_id` (`get-event-types.response.503.request_id`; string, required)
- `detail` (`get-event-types.response.503.detail`; string, optional)
- `errors` (`get-event-types.response.503.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`get-event-types.response.503.errors.path`; string, required)
  - `code` (`get-event-types.response.503.errors.code`; string, required)
  - `message` (`get-event-types.response.503.errors.message`; string, required)
  - `context` (`get-event-types.response.503.errors.context`; map<string | number | boolean>, optional) — 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` (`get-event-types.response.503.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`get-event-types.response.503.third_party.source`; string, required)
  - `message` (`get-event-types.response.503.third_party.message`; string, required)
  - `code` (`get-event-types.response.503.third_party.code`; string, optional)


Source: https://docs.invox.page/api/get-event-types/index.md
