# POST /v3/callbacks/endpoints

Create a webhook endpoint.

**API key:** required. See [Authentication](https://www.secblast.com/docs/authentication).

**Group:** [Webhooks (API: callbacks)](https://www.secblast.com/docs/reference#webhooks-api-callbacks)

## Parameters

This route takes no parameters.

## Request body

A [CallbackEndpointCreate](https://www.secblast.com/docs/reference/schemas#schema-callbackendpointcreate) object, as JSON.

| Field | Type | Required | Description |
|---|---|---|---|
| `description` | string \| null | no | At most 800 bytes. |
| `event_types` | array of string | yes |   |
| `url` | string | yes | https only, port 443 only, no user name or password, a public DNS name (not an IP address, localhost, .local or .internal) of letters, digits and hyphens (an international name in its xn-- form) that resolves to a public address; at most 2,048 characters. |

## Responses

| Status | Body | Description |
|---|---|---|
| `201` | [CallbackEndpointCreated](https://www.secblast.com/docs/reference/schemas#schema-callbackendpointcreated) (`application/json`) | Created |
| `400` | [Problem](https://www.secblast.com/docs/reference/schemas#schema-problem) (`application/problem+json`) | Invalid or unknown parameter, or a body that is not one JSON document (code invalid_body). |
| `401` | [Problem](https://www.secblast.com/docs/reference/schemas#schema-problem) (`application/problem+json`) | Missing, invalid or inactive API key (code unauthorized), or a refused access token (code invalid_token: malformed, unknown key, bad signature, expired, wrong issuer or audience, revoked grant). WWW-Authenticate names the protected-resource metadata (RFC 9728). |
| `403` | [Problem](https://www.secblast.com/docs/reference/schemas#schema-problem) (`application/problem+json`) | The credential's scope does not cover this route (code forbidden), or the organization's plan has no callbacks (code plan_required). |
| `409` | [Problem](https://www.secblast.com/docs/reference/schemas#schema-problem) (`application/problem+json`) | The plan's limit of active endpoints is reached (code limit_reached, with members kind, limit and used); or the endpoint changed while a PATCH was being checked (code conflict: retry). |
| `415` | [Problem](https://www.secblast.com/docs/reference/schemas#schema-problem) (`application/problem+json`) | The body is not sent as Content-Type: application/json (code unsupported_media_type). |
| `503` | [Problem](https://www.secblast.com/docs/reference/schemas#schema-problem) (`application/problem+json`) | Callbacks are not available: this server has no callback key file or its database lacks the callback tables (code callbacks_unavailable); too many callback URLs are being checked at once (code db_unavailable, reason resolver_busy, Retry-After 1); or the database is unavailable (code db_unavailable). |
| `default` | [Problem](https://www.secblast.com/docs/reference/schemas#schema-problem) (`application/problem+json`) | Any other error (405, 500, 504). |

## Response body

A `201` carries a [CallbackEndpointCreated](https://www.secblast.com/docs/reference/schemas#schema-callbackendpointcreated) object.

| Field | Type | Required | Description |
|---|---|---|---|
| `active` | boolean | yes |   |
| `created_at` | date-time (RFC 3339, UTC) | yes |   |
| `description` | string \| null | yes |   |
| `event_types` | array of string | yes |   |
| `health` | object | yes |   |
| `health.consecutive_failures` | integer | no |   |
| `health.disabled_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `health.disabled_reason` | string \| null | no |   |
| `health.failing_since` | date-time (RFC 3339, UTC) \| null | no |   |
| `health.last_success_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `health.state` | string | yes | One of: `unverified`, `active`, `failing`, `disabled`. |
| `health.verified_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `id` | string | yes | cbe_ and 24 hex digits. |
| `last_24h` | object | yes | Deliveries of the last 24 hours by state. |
| `last_24h.delivered` | integer | no |   |
| `last_24h.dropped` | integer | no |   |
| `last_24h.failed` | integer | no |   |
| `last_24h.held` | integer | no |   |
| `updated_at` | date-time (RFC 3339, UTC) | yes |   |
| `url` | string | yes | As stored: https, the host in lower case, no :443, / for an empty path. |
| `secret` | string | yes | whsec_ and the standard base64 (with padding) of 32 random bytes: the Standard Webhooks signing secret. Shown only in this answer. |

## Example request

```bash
curl -sS -X POST -H "Authorization: Bearer $SECBLAST_API_KEY" \
  -H "Content-Type: application/json" -d @body.json \
  'https://api.secblast.com/v3/callbacks/endpoints'
```

## More in Webhooks (API: callbacks)

Previous: [`GET /v3/callbacks/endpoints`](https://www.secblast.com/docs/reference/get-callbacks-endpoints) · Next: [`GET /v3/callbacks/endpoints/{id}`](https://www.secblast.com/docs/reference/get-callbacks-endpoints-id)
