Skip to content
View as Markdown

Handle Bounce​

POST
/public/bounce_handler/{service_name}/{security_code}

Webhook endpoint for email service providers to report bounces, complaints, and unsubscribes. This is the shorter path variant without /handle/. The FluentCRM router registers this route as ANY; it is represented as POST here because OpenAPI requires a concrete operation method. Validates the security code and processes the bounce event for built-in services. Custom services can be handled via the fluent_crm_handle_bounce_{service_name} filter.

Parameters​

Path Parameters

service_name*

Email service provider name. Built-in handlers include mailgun, pepipost, postmark, sendgrid, sparkpost, elasticemail, postalserver, smtp2go, brevo, and tosend. Custom provider slugs are also allowed and can be handled with the fluent_crm_handle_bounce_{service_name} filter.

Type
string
Required
security_code*

Security code for webhook authentication. Must match the stored bounce key.

Type
string
Required

Request Body​

application/json
JSON
{
"additionalProperties": "string"
}

Responses​

Bounce request processed. The controller returns a success payload for valid requests, and also returns an error-shaped JSON body when the security code is invalid.

application/json
JSON
{
"success": 1,
"message": "recorded",
"service": "sendgrid",
"result": "bounced",
"time": 1709312400
}

Playground​

Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI