In this article
- Introduction
- Before you start
- Step-by-step
- Frequently asked questions
E-goi offers you hundreds of direct integrations and an API for remote operations, such as adding contacts or sending out campaigns.
What is the E-goi API?
In addition to hundreds of direct integrations, we've got an API (Application Programming Interface) designed to do things remotely on E-goi (eg. uploading contacts, sending campaigns, etc.).
What is Goidini?
Goidini is our kind-of-magic tool that helps you set up most E-goi integrations with just a few clicks.
Your Goidini login and password are the same as E-goi's.
Once logged into Goidini, simply choose the integration you need and follow the steps to complete setup.
What is a webhook?
E-goi webhooks can auto-notify a URL of your choice whenever something in your contact list happens, such as when a contact opts in, when a contact clicks through your email, etc.
When the event happens, E-goi will usually POST an HTTP to the URL you selected. You can then store and process our data on your side for use in another software or service.
Before you start
Security and needs
Prior to using the E-goi API, be sure to:
- Check your integration needs: Consider beforehand what you'll actually be doing via API, be it syncing contacts, triggering email sends or enabling any other E-goi feature.
- Understand that security is key: Your API key is as sensitive as your password. Keep it safe at all times.
- Confirm your type of E-goi account: The API key is not available for trial accounts and the free Social One plan.
Step-by-step
Locating your API key
1) Log into E-goi, click the upper right-corner menu and hit Integrations.
2) You'll find your API key ready for copying.
Safely handling your API key
Make sure to use your API key only when an integration requires it. Avoid sharing it with others, as anyone who gets it can hijack your account with basic programming skills. Keep it secret, keep it safe - just like your password.
What to do if your API key is stolen
Generate a new key as soon as you can:
1) Head over to your user menu (upper right corner) and click Integrations.
2) Scroll down the integrations page and hit the Regenerate key button.
Creating a webhook
1) Click the menu in the upper right corner (where you see your user icon or profile picture) and choose Integrations.
2) In the left panel, hit Integrations.
Creating a webhook
Go to the Webhook management section and click Add Webhook. Enter the webhook's URL (ie. your URL which E-goi will send data to), choose the contact list containing the data you'll be sending and tick the events you want to send (list sign-ups, email opens, etc.). Click Save to create your webhook.
From then on, every time one of the events you chose happens in your contact list, E-goi will post the event data to your webhook URL.
Creating a webhook for transactional messages
Go to the Transactional webhook management section and click Add webhook. Enter the webhook's URL (ie. your URL which E-goi will send data to), choose the type of transactional message to check for (email or SMS) and tick the events you want to send (list sign-ups, email opens, etc.). Click Save to create your webhook.
From then on, every time one of the events you chose happens in your transactional messages, E-goi will post the event data to your webhook URL
Viewing stats and logs
1) Click the menu in the upper right corner (where you see your user icon or profile picture) and choose Integrations.
2) In the left-hand panel, you'll find:
- API statistics
- Stats for your webhooks
- Stats for your transactional message webhooks
- Stats for the Registered Message API
For each stat, in addition to totals, you'll see a list of all requests made. Each one includes:
- URL
- Date and time
- Response code
- Complete request data, including:
- Request (payload)
- Response code
- Response header
- Response time
- Full response
Frequently asked questions
Is it hard to use your API to whip up an integration?
Not at all. Our API was designed with flexibility and ease-of-use in mind. If you're a developer, check out our API docs, You can integrate E-goi with any system, website, app or software.
Where can I find API integration examples?
Our API docs are your best bet, as they include multiple coding scenarios and use cases.