# Save webhook settings

`PUT /api/webhook/outbound/config`  (operationId: `putWebhookConfig`, group: Webhooks)

Registers one HTTPS endpoint and the events to send. The signing secret is returned on the first save only. Scale events are refused for a workspace without API access, so nothing is subscribed that would never fire. Changes apply immediately.

Part of the full API, which is included in the Scale plan. Workspace admin: a dashboard session, or a full-access key created by an admin. A scoped key is refused with scope_denied.

**Request body** (JSON, required)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `endpoint_url` | string (uri) | yes | http or https endpoint that accepts POST. |
| `events` | array of string | yes | One or more event names from the catalogue. |
| `enabled` | boolean | no | Default true. |
| `credit_alert_levels` | array of integer | no | Percent levels for credits_threshold. Default [80, 100]. |

Example:

```json
{
  "endpoint_url": "https://example.com/hooks/inboxwa",
  "events": [
    "message_received",
    "message_status",
    "credits_threshold"
  ],
  "credit_alert_levels": [
    80,
    100
  ]
}
```

**Response 200**: Saved.

Example:

```json
{
  "success": true,
  "endpoint_url": "https://example.com/hooks/inboxwa",
  "events": [
    "message_received",
    "message_status"
  ],
  "enabled": true,
  "signing_secret": "9f2c...e41a",
  "message": "Outbound webhook configured. Save the signing secret -- it will not be shown again."
}
```

**Errors specific to this call.** The common ones (401, 403, 429 and the rest) are in the [Errors guide](https://inboxwa.online/docs/api/guide/errors.md).

| Status | error | When |
| --- | --- | --- |
| 400 | `endpoint_url_required` | No endpoint. |
| 400 | `invalid_url` | Not an http or https URL. |
| 400 | `events_required` | No events. |
| 403 | `event_requires_scale` | A chosen event needs API access on the plan. |

Part of the InboxWA API reference: https://inboxwa.online/docs/api . Full reference as one document: https://inboxwa.online/docs/api.md . OpenAPI: https://inboxwa.online/openapi.json