Postback
- Creating a postback
- Section description
- Request settings
- List of macros
- Authentication settings
- Postback testing
Creating a postback
You can create a postback in the following section: https://gs.kit.global/postbacks/
To add a new postback, click the corresponding button – Add postback.
Next, you’ll find yourself on the page where you’ll make the actual postback.
https://gs.kit.global/postbacks/new/
Section description
Postback title and conditions.
Title – name the postback whatever you feel like.
Address – the link that will submit the request.
For orders placed with a specific advertiser – a specific advertiser, from whose orders you’ll get postback. Select an option from the dropdown list.
For specific order statuses – you’ll get postback info to whatever address you specified when orders gain a specific status.
Possible options:
- created;
- cancelled;
- pending;
- confirmed;
- payed.
You can use multiple options simultaneously.
Active – a postback parameter indicating whether it’s on or off.
If the former, you’ll get sent postbacks, if the latter – you won’t. But the parameter will remember your settings.
HTTP request type. Select a request type. The two most commonly used request-response methods between client and server are GET and POST.
If you pick GET, you can immediately move on to setting up the parameters you’ll be receiving info for.
If you pick POST, you’ll need to first select the type of transmitted parameters.
In json and xml you write out the body of the request: For example:
JSON:
{ order_number: *order_id*, offer: *merchant_id*, earn: *profit* }
|
XML:
<root> <earn>*profit*</earn> <offer>*merchant_id*</offer> <order_number>*order_id*</order_number> </root>
|
Transmittable parameters (if you pick the GET or POST with params method)
This is the section where you add postback parameters.
Assigned title – a name of your choice, depending on what sort of parameter you wish to receive on your end.
Value – the macro we’ll be sending to Assigned title
List of macros
Parameter |
Description |
*gs_order_id* |
The order’s title in the system |
*merchant_id* |
The advertiser’s number in the system |
*sub_id*, *sub_id2*, etc |
sub_id parameter value |
*profit* |
Webmaster income |
*order_id* |
Advertiser order number |
*order_sum* |
Total order amount |
*click_time* |
Transition time |
*action_time* |
Time when the advertiser created the order |
*user_agent* |
Client app ID string |
*state* |
Conversion status. Acceptable values: 0 — created 1 — cancelled 2 — pending 3 — confirmed 4 — payed You can select multiple options. |
*price_in_currency* |
Currency amount |
*offer_name* |
Offer title |
*currency* |
Currency |
HTTP headers. In this section you set up titles for authentication (if necessary). If you have no need for them, just leave the field blank.
Title – the header name, such as Authorization;
Value – authorization key.
Click Save.
To send the data, use the following website https://webhook.site/
Settings example:
To submit the test postback, click Test from the general list in the following section https://gs.kit.global/postbacks/
OR when viewing a specific postback:
That’ll open a window where you input test values. Fill out all the fields you need and make sure (!) to specify the merchant_id and state.
merchant_id – needs to match the advertiser’s ID.
status – needs to match the statuses you selected, but in a numerical value.
If you don’t fill out these two fields – you’ll end up getting an error message.
If the postback is successfully sent, you’ll get a response with the 200 status at the bottom.
You can see the postback data on the test website to where you sent the request.