# Subscribe to signed public events

Requires webhook:create, webhook:read, and thread:read. The subscription belongs to the stable service account, not its minting credential: credential rotation or revocation does not stop deliveries. Disable the account or subscription, or remove its read grants, to stop delivery. Returns the signing secret once. HMAC-SHA256 covers timestamp + '.' + exact request body bytes. Hoplite-Signature carries t=<unix seconds>,v1=<hex>. Verify within five minutes. During 24-hour secret rotation overlap either v1 signature is valid. Deliveries are at-least-once and unordered; deduplicate by event ID, independently of delivery ID. Only public HTTPS destinations are accepted; DNS is pinned and redirects are refused.

`POST /api/webhooks`

Required permission: `webhook:create`.

## Parameters

| Name | In | Type | Required | Description |

| --- | --- | --- | --- | --- |

| `Idempotency-Key` | header | `string` | No | Required for writes authenticated by a service credential and for service-account lifecycle writes. Other session writes may opt in. Reuse the key and payload for retries. Settled keys remain reserved for at least seven days; a transient 4xx releases its key. Changed payloads return 409. Match any legacy clientOperationId/clientMessageId in the body. |

## Request body

| Field | Type | Required | Constraints | Description |
| --- | --- | --- | --- | --- |
| `url` | `string<uri>` | Yes | max length 2048 | — |
| `projectId` | `string \| null` | No | — | — |
| `projectId.Option 1` | `string` | No | min length 1 | — |
| `projectId.Option 2` | `null` | No | — | — |
| `types` | `string[]` | No | max 30 items | — |
| `types.[item]` | `string` | No | min length 1, max length 100 | — |

```json
{
  "url": "https://factory.example.com/events",
  "projectId": "project_example",
  "types": [
    "run.completed"
  ]
}
```

## Example request

```bash
curl --request POST \
  --url https://api.hoplite.sh/api/webhooks \
  --header "X-Api-Key: $HOPLITE_API_KEY" \
  --header "Idempotency-Key: $HOPLITE_OPERATION_ID" \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://factory.example.com/events",
  "projectId": "project_example",
  "types": [
    "run.completed"
  ]
}'
```

## 201 response

Successful response

Content type: `application/json`. Response type: `object`.

| Field | Type | Required | Constraints | Description |
| --- | --- | --- | --- | --- |
| `ok` | `boolean` | Yes | constant true | — |
| `subscription` | `object` | Yes | — | — |
| `subscription.id` | `string` | Yes | — | — |
| `subscription.orgId` | `string` | Yes | — | — |
| `subscription.projectId` | `string \| null` | Yes | — | — |
| `subscription.url` | `string` | Yes | — | — |
| `subscription.types` | `string[]` | Yes | — | — |
| `subscription.types.[item]` | `string` | No | — | — |
| `subscription.disabled` | `boolean` | Yes | — | — |
| `subscription.createdAt` | `string<date-time>` | Yes | — | — |
| `subscription.updatedAt` | `string<date-time>` | Yes | — | — |
| `secret` | `string` | No | — | — |
| `secretUnavailable` | `boolean` | No | — | — |

```json

```

## Response headers

| Header | Type | Statuses | Description |

| --- | --- | --- | --- |

| `RateLimit` | `string` | `201`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Current ingress policy, remaining requests, and seconds until reset, for example `"ingress";r=599;t=60`. |

| `RateLimit-Policy` | `string` | `201`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Ingress quota and window, for example `"ingress";q=600;qu="requests";w=60`. |

| `X-RateLimit-Limit` | `integer` | `201`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Maximum requests allowed in the current rolling window. |

| `X-RateLimit-Remaining` | `integer` | `201`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Requests remaining in the current rolling window. |

| `X-RateLimit-Reset` | `integer` | `201`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Unix timestamp when the current rolling window resets. |

| `x-request-id` | `string` | `201`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Request correlation ID. |

| `Retry-After` | `integer` | `429`, `503` | Seconds until another request should be attempted. |

| `X-Retry-After` | `integer` | `429`, `503` | Legacy retry delay in seconds. |

## Status codes

- `201` — Successful response

- `400` — Invalid request. Validation responses include field paths.

- `401` — The API key is missing, invalid, or lacks the operation's permission.

- `402` — The organization does not have access to the requested product capability.

- `403` — The key's current user no longer has the required organization membership or role.

- `404` — The resource is not available in the authenticated scope.

- `409` — The request conflicts with a retry receipt or current resource state.

- `410` — The event cursor has expired; capture a fresh head and resource snapshot.

- `429` — The API-key rate limit has been exceeded.

- `500` — The API encountered an unexpected failure.

- `501` — The deployment has not configured the requested capability.

- `503` — A required API dependency, including the rate limiter, is unavailable.