REST API for Purchase Nudges

Nudgify’s REST API allows you to show the data you want in your Purchase Nudges without having to rely on any third party integration. Our API makes it easy for developers to turn purchases into Social Proof.

This documentation describes how to successfully call the Nudgify API to show you order data in Nudges. Are you looking to show sign-ups or other conversions which do not include line item information? Go to our API documentation for sign-ups.

Before you start

For the Purchase Nudges, requests are made to: https://app.nudgify.com/api/purchases

You will need access to the following:
– Your Nudgify Site Key
– Your Nudgify API Key

You can find the Site and API Keys for each site in your Nudgify account on your Sites page.

Authentication

The Nudgify API uses HTTP Bearer Authentication to authenticate requests. This allows you to protect the URLs on your web server so that only you and Nudgify can access them.

You use your Nudgify API key as the bearer token. You can find your API Key in your Nudgify account settings. Use: Authorization: Bearer <API key>

Be sure to keep your API Key secure. Do not share your API key in publicly accessible areas such as GitHub, client-side code, and so forth so that it cannot be copied or stolen in any way.

All requests must be secure, i.e. https, not http.

Required headers

accept: application/json
content-type: application/json

Parameters

You can use the parameters below to push your orders into your Purchase Nudges.

Example request body

{
  "site_key": "510eeb08-814e-456a-b5c1-8c7c70cc4c00",
  "orders": 
  [{
    "order_id": "1111",
    "date": "2021-04-15 04:29:42",
    "email": "[email protected]",
    "first_name": "Leon",
    "last_name" : "Gomes",
    "ip": "92.21.8.106",
    "city": "Los Angeles",
    "state": "California",
    "country": "US",
    "line_items": 
    [{
      "item_id": "786",
      "item_variation_id": "SKU-786",
      "item_name": "LCD Display (Upgrade)",
      "item_link": "https://stroem.com/product/lcd",
      "image_url": "https://stroem.com/wp-content/LCD.png"
      },
      {
      "item_id": "777",
      "item_variation_id": "SKU-777",
      "item_name": "Throttle",
      "item_link": "https://stroem.com/product/upg",
      "image_url": "https://stroem.com/wp-content/Upg.png"
    }]
  }]
}

Example request

curl --request POST \
--url https://app.nudgify.com/api/purchases \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'authorization: Bearer 
IqJ4GRuODEsFBamKJb3LYXfEf456rVXWeRAkFnvCtXmlbq' \
--data '{
  "site_key":"510eeb08-814e-456a-b5c1-8c7c70cc4c00",
  "orders":[{
    "order_id":"1111","date":"2021-04-15 04:29:42",
    "email":"[email protected]",
    "first_name":"Leon",
    "last_name":"Gomes",
    "ip":"92.21.8.106",
    "city":"Los Angeles",
    "state":"California",
    "country":"US",
    "line_items":[{
      "item_id":"786",
      "item_variation_id":"SKU-786",
      "item_name":"LCD Display (Upgrade)",
      "item_link":"https://stroem.com/product/lcd",
      "image_url":"https://stroem.com/wp-content/LCD.png"
    }]
  }]
}'

Success response

If your API request has been successful, you get a success response like the one below.

Response type: Json

{ 
  "message": "Request successfully saved.", 
  "data": [ "142" ] 
}

If your request has been successful, you can find the order data that has been sent through in the Purchases tab of your Nudgify Data Feeds.

Error response

In case your API request has failed, you get an error response like the one below.

Response type: Json

{
  "message": "Bad Request.",
  "errors": {
    "orders.0.email": [
    "Email is required."
    ],
    "orders.1.date": [
    "Date is required."
    ]
  }
}

Possible errors

To help you identify why your API request has failed and what you need to adjust to get a success response, we have made an overview of the possible error messages and what they mean.

Error Messages

In case you have any questions or comments about our API, please don’t hesitate to get in touch via our support chat.