# registerWebhookSubscription

Source: /openapi/thomas-federated.openapi.json

## Operation

| Method | URL |
|---|---|
| POST | https://staging-api.thomas.co/v1/webhook-subscriptions |

| Field | Value |
|---|---|
| operationId | registerWebhookSubscription |
| method | POST |
| server | https://staging-api.thomas.co/v1 |
| path | /webhook-subscriptions |
| tags | `Partner Events & Webhooks` |
| summary | Register a webhook endpoint |
| badges | None |

## Request Parameters

| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| Idempotency-Key | header | true | string | An opaque client-generated key, 1-255 visible ASCII characters excluding comma. Repeating a request with the same key and the same body returns the ORIGINAL response — including the secret it minted — instead of minting a second one. |

## Request Body

| Content type | Schema refs |
|---|---|
| application/json | #/components/schemas/WebhookSubscriptionCreateRequestDto |

## Responses

| Status | Description | Schema refs |
|---|---|---|
| 201 | The subscription was configured. `signingSecret` is shown here and nowhere else. | #/components/schemas/WebhookSubscriptionCreateResponseDto |
| 400 | The request could not be accepted as sent. | #/components/schemas/ApiErrorResponseDto |
| 401 | Invalid or missing authentication token (AUTH_TOKEN_INVALID) | #/components/schemas/ApiErrorResponseDto |
| 403 | Only a provisioned Partner-owned API client may call this operation | #/components/schemas/ApiErrorResponseDto |
| 409 | The request conflicts with the current state of this API client. | #/components/schemas/ApiErrorResponseDto |
| 422 | The webhook endpoint is not a safe public HTTPS destination. | #/components/schemas/ApiErrorResponseDto |
| 429 | Rate limit exceeded. | #/components/schemas/ApiErrorResponseDto |
| 503 | This deployment has no webhook signing key provisioned | #/components/schemas/ApiErrorResponseDto |

### Response 429 headers

| Name | Description | Schema |
|---|---|---|
| Retry-After | Seconds until the rate-limit block expires before retrying. | {"type":"integer","minimum":0} |
| RateLimit-Limit | Configured request limit for the active rate-limit window. | {"type":"integer"} |
| RateLimit-Remaining | Requests remaining in the active rate-limit window; zero when blocked. | {"type":"integer"} |
| RateLimit-Reset | Seconds until the rate-limit block expires. | {"type":"integer","minimum":0} |

## Artifact Examples

### Response 401 example

```json
{
  "statusCode": 401,
  "message": "Invalid or missing authentication token",
  "error": "AUTH_TOKEN_INVALID"
}
```

### Response 403 example

```json
{
  "statusCode": 403,
  "message": "API client is not permitted to call this operation",
  "error": "PRINCIPAL_TYPE_NOT_ALLOWED"
}
```

### Response 429 example

```json
{
  "statusCode": 429,
  "message": "ThrottlerException: Too Many Requests",
  "error": "HTTP_TOO_MANY_REQUESTS"
}
```

### Response 503 example

```json
{
  "statusCode": 503,
  "message": "Webhook signing is not configured on this deployment",
  "error": "WEBHOOK_SIGNING_NOT_CONFIGURED"
}
```