REST API for Sign-up Nudges

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

Our REST API requires some coding and is meant to be used by developers. Are you not a developer and do you not have access to one? It might be better to choose one of the other integration options to connect your Sign-ups.

This documentation describes how to successfully call the Nudgify API to show you sign-up data in Nudges. For convenience, we say sign-ups, but it can be any type of conversion, such as form submissions, newsletter subscriptions etc.

Are you looking to show your purchases or other type of conversions that include line item information? Go to our API documentation for purchases.

Before you start

For the Sign-up Nudges, requests are made to: https://app.nudgify.com/api/conversions

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.

Activate the REST API as data source

Before you send your request, you need to enable the REST API in your Nudgify account. Follow these steps to activate the REST API.

• Add a Sign-up Nudge to your Stream. Select the REST API from the dropdown of data sources, and click “Configure”.

• This triggers a pop up that invited you to click the “Enable REST API button”. Click this button to enable the REST API for you Nudgify account.

• The REST API is now enabled and you can send your request. Follow the steps below to send sign-up data to Nudgify via our REST API.

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.

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 conversions into your Sign-Up Nudges.

Example request body

{
  "site_key": "510eeb08-814e-456a-b5c1-8c7c70cc4c00",
  "conversions": [{
    "date": "2021-04-15 04:29:42",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Mendes",
    "ip": "92.21.8.106",
    "city": "Houston",
    "state": "Texas",
    "country": "US"
    },
    {
    "first_name": "Cicilia",
    "last_name": "Mendes",
    "email": "[email protected]",
    "ip": "92.21.8.106",
    "date": "2021-04-16 04:29:42",
    "city": "London",
    "state": "",
    "country": "GB"
  }]
}

Example request

curl --request POST \
--url https://app.nudgify.com/api/conversions \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'authorization: Bearer 
IqJ4GRuODEsFBamKJb3LYXfEf456rVXWeRAkFnvCt' \
--data '{
  "site_key":"510eeb08-814e-456a-b5c1-8c7c70cc4c00",
  "conversions":[{
    "date":"2021-04-15 04:29:42",
    "email":"[email protected]",
    "first_name":"John",
    "last_name":"Mendes",
    "ip":"92.21.8.106",
    "city":"Houston",
    "state":"Texas",
    "country":"US"
  }]
}'

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": [ "141" ] 
}

If your request has been successful, you can find the sign-up data that has been sent through in the Sign-ups tab of your Nudgify Data Feeds.

Error response

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

Response type: Json

{
  "message": "Bad Request.",
  "errors": {
    "conversions.0.email": [
    "Email is required."
    ],
    "conversions.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

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