Campaigns Webhooks

These are the steps that the client will need to take:

1. Define the Endpoint URL

Create an endpoint URL on the client’s server where Flow will send webhook notifications. This URL should be publicly accessible without authentication other than IP whitelisting, and should be configured to receive a JSON payload. Flow will send a POST request with the payload in JSON format in the body.

Here is an example of a Webhook payload:

{
    "event" : "draft", //"draft" or "publish"
    "draftExpiryDate" : "2024-10-01" //only on draft
    "flowCampaignId" : "12345",
    "facebookCampaignId" : "34567", //only on publish
    "campaignStartDate": "2024-06-21", //only on publish
    "campaignEndDate" : "2024-07-01", //only on publish & for FlowFuel
    "agentEmail": "[e-mail]",
    "agentExternalId": "15",
    "campaignName": "F202403445 - FlowFuel...", //only on publish
    "campaignType": "FlowFuel",
    "externalBranchId": "9",
    "flowPropertyId": "3423545kj23523l", //only on FlowFuel
    "listingReference": "XXX-15" //only on FlowFuel
    "externalRef" : optional, if provided in the JWT
    "environment" : "Test" //Test or Live
}

1. Secure the Endpoint

If security is required, configure the endpoint to authenticate incoming requests:

• IP Whitelisting: Limit access to known IP addresses, ensuring only Flow servers can send data to this endpoint.

1. Provide Endpoint Details to Flow

Share the endpoint URL and any authentication requirements (such as the API token) with Flow. Flow will configure its system to direct webhook events to this specified endpoint.

1. Specify Events to Track

Work with Flow to select the specific events that will trigger webhook notifications. Common webhook events include:

• Campaign Draft Created: Notifies when a new draft campaign is created.

• Campaign Published: Sends data when a campaign is successfully published.

• Campaign Status Updates: Sends updates on campaign progression or completion.

1. Test the Webhook Setup

Flow will send a test payload to the endpoint to ensure data is received and processed correctly. The client should validate that their endpoint processes and logs data as expected.