# Retrieve an event type (/docs/api-reference/hooks-event-types/get-hook-event-type)

An event type of the API key's environment, archived or not.

`GET https://api.coss.com/v1/hooks/event_types/{name}`

Authenticate with your API key as a bearer token (`Authorization: Bearer coss_test_…`). Responses are JSON with snake_case fields; errors are `{ error: { type, code, message, param?, issues?, request_id } }` (https://coss.com/docs/api-reference/errors.md).

## Path parameters

- `name` (string, required): The event type's name.

## Example request

TypeScript (the `coss` package):

```ts
import { Coss } from "coss";

const coss = new Coss({
  apiKey: process.env.COSS_API_KEY,
  baseUrl: "https://api.coss.com",
});

const { data, error } = await coss.hooks.eventTypes.get("invoice.paid");
```

HTTP:

```sh
curl -X GET "https://api.coss.com/v1/hooks/event_types/invoice.paid" \
  -H "Authorization: Bearer $COSS_API_KEY"
```

Python:

```python
from coss import Coss

client = Coss()  # api_key= or COSS_API_KEY

client.hooks.event_types.get(
    name="invoice.paid",
)
```

Go:

```go
import (
	"context"

	cossclient "github.com/cosscom/coss-go/client"
	hooks "github.com/cosscom/coss-go/hooks"
)

client := cossclient.NewClient() // option.WithAPIKey(…) or COSS_API_KEY

request := &hooks.GetEventTypesRequest{
    Name: "invoice.paid",
}
client.Hooks.EventTypes.Get(
    context.TODO(),
    request,
)
```

Ruby:

```ruby
require "coss"

client = Coss::Client.new # api_key: or COSS_API_KEY

client.hooks.event_types.get(name: "invoice.paid")
```

PHP:

```php
<?php

use Coss\Coss;

$client = new Coss(); // apiKey: or COSS_API_KEY

$client->hooks->eventTypes->get(
    'invoice.paid',
);
```

Java:

```java
import com.coss.Coss;

Coss client = Coss.builder().build(); // .apiKey(…) or COSS_API_KEY

client.hooks().eventTypes().get(
    "invoice.paid",
    GetEventTypesRequest
        .builder()
        .build()
);
```

.NET:

```csharp
using Coss;

var client = new CossClient(); // apiKey: or COSS_API_KEY

await client.Hooks.EventTypes.GetAsync(
    new Coss.Hooks.GetEventTypesRequest { Name = "invoice.paid" }
);
```

## Response 200

The event type.

- `object` ("hook_event_type", required)
- `name` (string, required): The type's name, which messages send as `event_type`.
- `description` (string | null, required): What this event means, shown to your users. `null`: none.
- `schema` (map of any | null, required): A JSON Schema of the payload, shown to your users (not enforced). `null`: none.
- `examples` (map of any[], required): Sample payloads, shown to your users. Test sends use the first.
- `archived` (boolean, required): Archived types are hidden from the portal and can't be subscribed to; messages of the type are still delivered to endpoints that subscribed before.
- `created_at` (string, required, date-time)
- `updated_at` (string, required, date-time)

Example:

```json
{
  "object": "hook_event_type",
  "name": "invoice.paid",
  "description": "An invoice was paid in full.",
  "schema": {
    "type": "object",
    "properties": {
      "invoice_id": {
        "type": "string"
      },
      "amount": {
        "type": "integer"
      }
    }
  },
  "examples": [
    {
      "invoice_id": "in_1042",
      "amount": 4200,
      "currency": "usd"
    }
  ],
  "archived": false,
  "created_at": "2026-01-15T09:30:00.000Z",
  "updated_at": "2026-01-15T09:30:00.000Z"
}
```

## Errors

- `400`: The `Coss-Version` header names an unknown API version (`invalid_api_version`).
- `401`: The API key is missing, invalid, revoked or expired (`authentication_error`).
- `403`: The API key lacks the permission this endpoint needs (`permission_error`), or its organization is suspended (`organization_suspended`).
- `404`: No event type with this name exists in the API key's environment (`not_found`).
- `429`: Too many requests with this API key (`rate_limited`), or too many requests with invalid keys from this address (`too_many_failed_authentications`). Retry after `Retry-After` seconds. Successful responses carry `RateLimit-Limit`, `RateLimit-Remaining` and `RateLimit-Reset` (seconds until the limit is fully restored).
- `500`: Unexpected server error (`api_error` / `internal_error`).
- `503`: The API key could not be verified right now; retry (`service_unavailable`).