Skip to main content
POST
Create Partner Postback
Create a new partner postback. Partner postbacks fire a notification when a specified conversion event occurs, allowing external systems to be notified. The delivery method determines how the postback is sent (server-to-server, HTML pixel, or through Meta/TikTok/Snapchat/Rumble integrations).

Authorizations

X-Eflow-Api-Key
string
header
required

The Everflow API key generated from the Control Center > Security.

Body

application/json
delivery_method
enum<string>
required

Determines how the postback will be fired. postback fires server-to-server (S2S). html fires from an HTML tag/pixel. facebook (Meta), tiktok, snapchat, and rumble fire through their respective integrations.

Available options:
postback,
html,
facebook,
tiktok,
snapchat,
rumble
pixel_level
enum<string>
required

Scope of the postback. global fires for a specific partner across all offers (set network_affiliate_id, network_offer_id to 0). specific fires for a specific offer/affiliate combination (set both IDs). global_offer fires for all affiliates on a specific offer (set network_offer_id, network_affiliate_id to 0). Not available when pixel_type is cpc.

Available options:
global,
specific,
global_offer
pixel_status
enum<string>
required

Postback status.

Available options:
active,
inactive
pixel_type
enum<string>
required

conversion fires for the base conversion action. event fires for any post-conversion events. cpc is used specifically for offers with CPC payouts and fires on every unique payable click action. When cpc is selected, pixel_level cannot be changed.

Available options:
conversion,
cpc,
event
network_offer_id
integer

Associated offer ID. Required when pixel_level is specific or global_offer. Set to 0 when pixel_level is global.

network_affiliate_id
integer

Associated affiliate ID. Required when pixel_level is specific or global. Set to 0 when pixel_level is global_offer.

postback_url
string

The postback URL. Required when delivery_method is postback. Supports macros like {transaction_id}. The URL requires the http:// or https:// protocol prefix.

html_code
string

HTML/iframe/image/JavaScript pixel code. Required when delivery_method is html.

description
string

Optional description for this postback.

delay_ms
integer

Delay in milliseconds before firing the postback. Only applicable when delivery_method is postback. Maximum 5 minutes (300000 ms).

network_offer_payout_revenue_id
integer

ID of the offer payout/revenue entry (event ID). Only relevant when pixel_type is event and pixel_level is specific or global_offer. Use 0 to fire for all events on the offer.

facebook_pixel
object

Meta (Facebook) pixel configuration. Required when delivery_method is facebook.

tiktok_pixel
object

TikTok pixel configuration. Required when delivery_method is tiktok.

snapchat_pixel
object

Snapchat pixel configuration. Required when delivery_method is snapchat.

rumble_pixel
object

Rumble pixel configuration. Required when delivery_method is rumble.

Response

200 - application/json
network_pixel_id
integer

Unique partner postback (pixel) ID.

network_id
integer

Network ID.

network_affiliate_id
integer

Associated affiliate ID (0 for all affiliates).

network_offer_id
integer

Associated offer ID. Only relevant if pixel_level is specific or global_offer. Set to 0 when pixel_level is global.

network_offer_payout_revenue_id
integer

ID of the offer payout and revenue entry associated with this postback, also known as the event ID. Only relevant when pixel_type is event and pixel_level is specific or global_offer. A value of 0 selects all payout and revenue / event IDs on the offer.

delivery_method
enum<string>

Determines how the postback will be fired. postback fires server-to-server (S2S). html fires from an HTML tag/pixel. facebook, tiktok, snapchat, and rumble fire through their respective integrations.

Available options:
postback,
html,
facebook,
tiktok,
snapchat,
rumble
pixel_level
enum<string>

Determines if the postback should be used for all offers (global), a specific offer/affiliate combination (specific), or all affiliates on a specific offer (global_offer).

Available options:
global,
specific,
global_offer
pixel_status
enum<string>

Postback status. Can be active or inactive.

Available options:
active,
inactive
pixel_type
enum<string>

conversion fires for the base conversion action. event fires for any post-conversion events. cpc is used specifically for offers with CPC payouts and fires on every unique payable click action.

Available options:
conversion,
cpc,
event
postback_url
string

The postback URL (used when delivery_method is postback). The URL requires the http:// or https:// protocol prefix.

html_code
string

HTML/iframe/image/JavaScript pixel code (when delivery_method is html).

description
string

Description of this postback.

delay_ms
integer

Optional delay in milliseconds that the system will wait before firing the postback. Only relevant when delivery method is postback. Maximum delay is 5 minutes (300000 milliseconds).

time_created
integer

Unix timestamp of creation.

Example:

1734455015

time_saved
integer

Unix timestamp of last update.

Example:

1734455015

facebook_pixel
object | null

Meta (Facebook) pixel configuration. Present when delivery_method is facebook.

tiktok_pixel
object | null

TikTok pixel configuration. Present when delivery_method is tiktok.

snapchat_pixel
object | null

Snapchat pixel configuration. Present when delivery_method is snapchat.

rumble_pixel
object | null

Rumble pixel configuration. Present when delivery_method is rumble.

relationship
object

Related entities. Contains offer when pixel_level is specific or global_offer, and affiliate when pixel_level is specific or global.