Payload reference

Payload format

The request body is a single JSON object with the following fields:

event · string · required

Event name that indicates what happened.

occurred_at · string · required

ISO-8601 timestamp of the underlying record update.

campaign_affiliate_id · integer · required

Internal ID of the campaign-creator association record.

campaign_id · integer · required

Campaign ID.

organization_id · integer · required

Organization ID.

user_id · integer · required

Creator’s user ID.

status · string · required

The raw status value on the record (e.g., active, removed, left).

campaign_name · string

Campaign name, when available.

organization_slug · string

Brand slug, when available.

user_email · string

Creator email, when available.

user_name · string

Creator name, when available.

tag · string

Default affiliate tag for the creator on this campaign, when available. For code_updated, this is the new code.

previous_tag · string

Present on campaign_affiliate.code_updated only. The affiliate code before the change.

idempotency_key · string

Stable key for deduplicating redelivered events (delivery is at-least-once).

attribution · object

Present when the creator was submitted through the campaign applications API. Echoes the marketing attribution you sent with the applicant — fbp, fbc, fbclid, event_id, event_source_url, UTM parameters, your external_id, and TikTok enrichment — so you can match the creator in your ad platform (for example, forwarding to Meta Conversions API).

Optional fields are omitted when values are not present. For status events, occurred_at uses the campaign affiliation record’s updated_at timestamp. For code_updated, it is the time the code change was committed.

Sale events

affiliate_sale.created fires when a sale is attributed to one of your creators (Shopify, website/API conversions, and app sales). On top of the shared fields above (campaign_name, organization_slug, user_email, user_name, tag, attribution), the payload carries:

affiliate_sale_id · integer · required

Growi’s id for the sale.

order_id · string · required

The external order id (e.g. the Shopify order).

total_cents · integer · required

Order total in cents.

subtotal_cents · integer

Order subtotal in cents.

commission_cents · integer

The creator’s commission in cents.

currency · string · required

ISO currency code (lowercase, e.g. usd).

platform · string · required

shopify, website, ios, or android.

sale_type · string

one_time or subscription.

sale_occurrence · string

initial for the customer’s first attributed sale, recurring for later purchases.

status · string

Payout status of the sale (e.g. unpaid).