Posting API
Configure post-submission API calls to buyers or sources after form completion or specific events.
Posting API
What is the Posting API?
The Posting API sends lead data from Pingtree to external endpoints (buyers or sources) automatically after a form submission or a specific event and can be filtered to only trigger based off of custom conditions.
How is Posting API Used in a Pingtree Campaign?
By default, Posting API is enabled for all buyers and sources via a global toggle. When enabled, Pingtree will send an API request once the configured trigger is met:
- Form Submission: after a lead completes a selected form.
- Event: when a specific event type occurs (selectable in the configuration).
If you disable the global toggle, you can scope the Posting API to individual buyers or sources.
Configuration Requirements
-
Endpoint URL
The URL where Pingtree will send the API request. -
Data & Field Mapping
Map only the lead attributes captured by Pingtree to the target endpoint’s expected parameters. Static values can be included if required. -
Request Method
- POST (default)
- GET (optional)
-
Payload Format
- JSON (default)
- XML
- x-www-form-urlencoded
- form-data
Trigger Types
Form Data Posting
Fires immediately after a lead form is successfully submitted.
Event Data Posting
Fires when a configured lead event occurs (e.g., sale, form step completion). Select the event from the dropdown.
Enabling & Scoping
-
Global Toggle
Enables Posting API for all buyers and sources by default. -
Scoped Selection
After toggling off globally, select specific buyers or sources to receive or skip the API. -
Event Selector
If using Event Data Posting, choose which event triggers the request.
Example Setup
- Navigate to Campaign > Distribution > Posting API.
- Toggle Enable Posting API on.
- Enter Endpoint URL, choose Request Method, and select Payload Format.
- Map your lead fields and any static values.
- Under Trigger, choose Form Submission or a specific Event.
- (Optional) Toggle off global scope and choose individual buyers/sources.
- Save and test using a sample
transaction_id
.
![REPLACE HERE: Posting API Flow Diagram]