Reward Using Trigger

post

https://platform.nector.io/api/v2/merchant/activities

This API is used to reward users based on the trigger. The trigger can be any of the following wallet reward, offer reward, email, event, or webhook. The trigger can be set up in the Nector dashboard and its _id can be fetched using Fetch Triggers. The earning rule of the trigger (once, once in a period, on activity count reached and so on) is evaluated on our side, so it is safe to call this API on every occurrence of the action. A trigger marked as open on the dashboard (is_open true in Fetch Triggers) can be fired with a read only api key, ex. from your storefront with a lead token. A trigger that is not open requires a write access api key and must be fired from your backend, so that customers cannot reward themselves. Refer to this article for the authentication flow when calling this API from a storefront or client side environment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

trigger_id

string

required

(Required) (This needs to be triggers _id value)

lead_id

string

(One of leadid, customer_id is required) (This needs to be leads id value)

customer_id

string

(One of lead_id, customer_id is required) (Minimum length is 8) (Maximum length is 128) (This needs to be leads customer_id value)

Headers

x-source

string

enum

required

(Required) (This can only be one of mobile,web) (web for browsers and servers, mobile for native apps)

Allowed:

x-apikey

string

required

(Required) (This needs to be your apikey)

x-workspaceid

string

required

(Required) (This needs to be your workspaceid)

x-leadtoken

string

(Required when using a storefront read only api key, not needed with a server api key) (This needs to be the lead_token of the customer, a 1 hour JWT returned by Get User via the x-leaddigest flow or generated on your server with your api signing secret) (When passed, the customer is taken from the token and any lead_id or customer_id in the request is ignored) (Learn more about authentication here)

Responses

200200

5XXUnexpected error on our side. Retry with backoff and share meta.request_id with [email protected] if it persists