Webhook

Create or replace the webhook configuration

patch/v1/projectId/{projectId}/webhook

Request

  • Base URL: https://api.bluefox.email
  • URL: https://api.bluefox.email/v1/projectId/{projectId}/webhook
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The project _id, found in the app under Project Settings.

Request body

urlstring required
secretKeystring required

Must match one of this project's existing API keys (managed in the app under Project Settings > API Keys - not exposed via this API).

bounceboolean
complaintboolean
clickboolean
openboolean
sentboolean
failedboolean
subscriptionboolean

Response

OK

statusinteger

Example response

{
  "status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.