Appearance
Webhook
Full reference for the Webhook resource in the bluefox.email API. See the API overview for authentication, the response envelope, and pagination.
Get the configured webhook
GET /v1/projectId/{projectId}/webhook
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
projectId | path | string | yes | The project _id, found in the app under Project Settings. |
Responses
| Status | Description |
|---|---|
| 200 | OK, result is null if no webhook is configured |
| 403 | Missing or invalid API key |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
url | string | ||
secretKey | string | ||
bounce | boolean | ||
complaint | boolean | ||
click | boolean | ||
open | boolean | ||
sent | boolean | ||
failed | boolean | ||
subscription | boolean |
Create or replace the webhook configuration
PATCH /v1/projectId/{projectId}/webhook
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
projectId | path | string | yes | The project _id, found in the app under Project Settings. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
url | string | yes | |
secretKey | string | yes | Must match one of this project's existing API keys (managed in the app under Project Settings > API Keys - not exposed via this API). |
bounce | boolean | ||
complaint | boolean | ||
click | boolean | ||
open | boolean | ||
sent | boolean | ||
failed | boolean | ||
subscription | boolean |
Responses
| Status | Description |
|---|---|
| 200 | OK |
| 400 | Invalid request body or query - every violation found (missing/invalid/unexpected fields) is reported in one response, semicolon-separated, not just the first one hit. |
| 403 | Missing or invalid API key |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
url | string | ||
secretKey | string | ||
bounce | boolean | ||
complaint | boolean | ||
click | boolean | ||
open | boolean | ||
sent | boolean | ||
failed | boolean | ||
subscription | boolean |
Remove the webhook configuration
DELETE /v1/projectId/{projectId}/webhook
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
projectId | path | string | yes | The project _id, found in the app under Project Settings. |
Responses
| Status | Description |
|---|---|
| 200 | Deleted |
| 403 | Missing or invalid API key |
| 404 | Webhook not found |