Notifications

1 min

POST

https://api.sandbox.tripleup.dev/reward_webhook_url

Note: This is not a valid triple API endpoint.

If a Publisher or Portfolio Manager subscribes to receive notifications we will send reward status messages to the registered endpoint. This describes what our outbound webhook call will provide to the triple partner.

The payload is contained as a string within the Message key sent by AWS SNS.

The transaction_amount and reward_amount fields are passed as strings but always contain decimal numerics.

Body Parameters

bodyRewardWebhook
Example
```
{
  "publisher_external_id": "pub-1231231",
  "card_program_external_id": "card-program-1234-5678",
  "card_account_external_id": "card-account-1234-5678",
  "transaction_external_id": "tx-12314",
  "offer_id": "34",
  "reward_id": "reward-1231231",
  "merchant_name": "Acme Tools",
  "reward_status": "PENDING_MERCHANT_APPROVAL",
  "reward_amount": "0.12",
  "reward_currency_code": "USD",
  "transaction_timestamp": "2022-07-30T00:43:00Z",
  "transaction_amount": "12.34",
  "transaction_currency_code": "USD"
}
```
Description
The Transaction webhook payload is contained within a Notification type SNS message. The documentation on this particular format is available in AWS docs at https://docs.aws.amazon.com/sns/latest/dg/sns-message-and-json-formats.html#http-notification-json
- publisher_external_idstring
  Description
  The external identifier for the publisher
- card_program_external_idstring
  Description
  The external identifier for the card program
- card_account_external_idstring
  Description
  The external identifier for the card account
- transaction_external_idstring
  Description
  The matching transaction which caused the reward to be triggered
- offer_idstring
  Description
  The identifier for the offer
- reward_idstring
  Description
  The identifier for the reward
- merchant_namestring
  Description
  The full name of the merchant offering the reward
- reward_statusstringrequired
  Description
  The status of the reward which currently is one of PENDING_MERCHANT_APPROVAL and DENIED_BY_MERCHANT with more statuses in the pipeline.
- reward_amountstring
  Description
  The amount of the reward earned
- reward_currency_codestring
  Description
  The currency code of the reward
- transaction_timestampstringrequired
  Description
  The timestamp of the initial transaction
- transaction_amountstringrequired
  Description
  The amount of initial transaction
- transaction_currency_codestring
  Description
  The currency code of the initial transaction

Responses

200Your server returns this code if it accepts the call.

401Unauthorized

curl

curl --request POST \
     --url https://api.sandbox.tripleup.dev/reward_webhook_url \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "reward_status": "",
     "transaction_timestamp": "",
     "transaction_amount": ""
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "reward_status": "",
   "transaction_timestamp": "",
   "transaction_amount": ""
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.sandbox.tripleup.dev/reward_webhook_url", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.sandbox.tripleup.dev/reward_webhook_url")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "reward_status": "",
   "transaction_timestamp": "",
   "transaction_amount": ""
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.sandbox.tripleup.dev/reward_webhook_url"

payload = json.dumps({
   "reward_status": "",
   "transaction_timestamp": "",
   "transaction_amount": ""
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Your server returns this code if it accepts the call.

401

// Unauthorized

Note: This is not a valid triple API endpoint.

The payload is contained as a string within the Message key sent by AWS SNS.

The transaction_amount and reward_amount fields are passed as strings but always contain decimal numerics.