Skip to content

Apollo

With the Apollo modules, you can do the following from your Apollo account.

  • watch, create, update and list the accounts

  • watch, create, update and list the contacts

  • create, update and list the opportunities

  • create and list the tasks

To get started with the Apollo, create an account at apollo.io.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connect Apollo with Ibexa Connect

To connect the Apollo app with the Ibexa Connect:

  1. Log in to your Apollo account.

  2. Click Settings.

    Apollo_2.png

  3. Click Integrations >API.

    Apollo_3.png

  4. Copy the API key and store it in a safe place.

    Apollo_4.png

  5. Log in to your Ibexa Connect and add a module from the Apollo into a Ibexa Connect scenario.

  6. Click Add next to the Connection field.

  7. In the Connection name field, enter a name for the connection.

  8. In the API Key field, enter the API key copied in step 4, and click Save.

You have successfully connected the Apollo app with Ibexa Connect and can now build scenarios.

Accounts

You can watch, create, update, and list the accounts using the following modules.

Watch New Accounts

Triggers when a new account is created.

Limit Set the maximum number of accounts Ibexa Connect will return during one execution cycle. The default value is 5.

Create an Account

Creates an account for a company in your database.

Account Name Enter the account's name.
Domain Enter the domain of the account you want to create. For example, google.com.
Phone Number Enter the corporate phone number of the account with the country code. For example, 1-866-246-6453.
Address Enter the address string for this account. Apollo will intelligently infer the city, state, country, and time zone from your address.

Update an Account

Updates information about the selected account.

Account ID Select or map the Account ID whose details you want to update.
Name Enter a new name for the account's name.
Domain Enter the domain of the account you want to create. For example, google.com.
Phone Number Enter (map) the corporate phone number of the account with the country code. For example, 1-866-246-6453.

List Accounts

Returns a list of accounts.

Organization Name

Enter the organization name whose account you want to list.

Account Stage IDs

Select or map the Stage IDs to list the accounts that matches the specified IDs.

  • Cold

  • Current Client

  • Active Opportunity

  • Dead Opportunity

  • Do Not Prospect

Sort by Field

Select the field to sort:

  • Account Last Activity Date

  • Account Created at

Sort Ascending

Select whether to sort the accounts in ascending order.

Limit

Set the maximum number of accounts Ibexa Connect will return during one execution cycle. The default value is 10.

Contacts

Watch New Contacts

Triggers when a new contact is created.

Limit Set the maximum number of contacts Ibexa Connect should return during one execution cycle. The default value is 5.

Watch Updated Contacts

Triggers when an existing contact is updated.

Limit Set the maximum number of contacts Ibexa Connect should return during one execution cycle. The default value is 5.

Created a Contact

Creates a contact for a person in your database.

First Name Enter (map) the contact's first name.
Last Name Enter (map) the contact's last name.
Company Name Enter (map) the contact's company name.
Title Enter (map) the contact's title. For example, Mr.
Account ID Select or map an Account ID to which the contact belongs to.
Email Enter (map) the contact's email address.
Labels Enter (map) a list of names to tag the newly created contact. If the name does not exist, Apollo will automatically create it
Contact Stage ID Select or map the Contact Stage ID. For example, approaching.
Address Enter (map) the contact's address. Apollo will intelligently infer the city, state, country, and time zone from your address.

Update a Contact

Updates information about the selected contact.

Contact ID Select or map a Contact ID whose details you want to delete.
First Name Enter (map) the contact's first name.
Last Name Enter (map) the contact's last name.
Company Name Enter (map) the contact's company name.
Title Enter (map) the contact's title. For example, Mr.
Account ID Select or map an Account ID to the contact belongs to.
Email Enter (map) the contact's email address.
Labels Enter (map) a list of names to tag the contact. If the label name does not exist, Apollo will automatically create it.
Address Enter (map) the contact's address. Apollo will intelligently infer the city, state, country, and time zone from your address.
Direct Phone Enter (map) the direct dial phone number for this contact. If the contact already has a direct dial, this overwrites it. If a contact does not already have a direct dial, this ADDS a new direct dial on top of existing phone numbers.
Corporate Phone Enter (map) the corporate phone number for this contact. If the contact already has a corporate phone, this overwrites it. If a contact does not already have a corporate phone, this ADDS a new corporate phone on top of existing phone numbers.
Home Phone Enter (map) the home phone number for this contact. If the contact already has a home phone, this overwrites it. If a contact does not already have a home phone, this ADDS a new home phone on top of existing phone numbers.
Other Phone Enter (map) any other phone numbers of the contact. If the contact already has a phone of an unknown type, this overwrites it. If a contact does not already have a phone of an unknown type, this ADDS a new phone on top of existing phone numbers.

List Contacts

Returns a list of contacts.

Keywords

Enter (map) the keywords to list the contacts. For example, the contact's name, title, company, or email.

Contact Stage IDs

Select or map an array of Stage IDs to which the contact must belong.

Sort by Field

Select or map the field to sort the contacts:

  • Contact Last Activity Date

  • Contact Email Last Opened at

  • Contact Email Last Clicked at

  • Contact Created at

  • Contact Updated at

Sort Ascending

Select whether to sort the contacts in ascending order.

Limit

Set the maximum number of contacts Ibexa Connect will return during one execution cycle. The default value is 10.

Opportunities

You can create, update, and list the opportunities using the following modules.

Create an Opportunity

Creates records that you can use to track possible deals with your prospective customers.

Owner ID Select or map a Owner ID whose opportunity you want to create.
Opportunity Name Enter (map) a name for the opportunity.
Amount of Money Involved Enter (map) the money involved in the opportunity.
Opportunity Stage ID Select or map the Opportunity Stage ID. For example, Qualify.
Closed Date Enter (map) the closing date for the opportunity. See the list of supported date and time formats.
Account ID Select or map an Account ID to associate the opportunity.

Update an Opportunity

Updates the details of an already existing opportunity.

Opportunity ID Select or map an Opportunity ID whose details you want to update.
Owner ID Select or map the Owner ID of the opportunity you want to update.
Name Enter (map) a new name for the opportunity.
Amount of Money Involved Enter (map) the amount of money involved in the opportunity.
Opportunity Stage ID Select or map the Opportunity Stage ID. For example, Quaify.
Closed Date Enter (map) the closing date for the opportunity. See the list of supported date and time formats.
Account ID Select or map the Account ID to associate the opportunity.

List Opportunities

Returns a list of opportunities.

Limit Set the maximum number of opportunities Ibexa Connect will return during one execution cycle.

Tasks

You can create, and list the tasks using the following modules.

Create a Task

Creates and assigns a task to a user.

Priority

Select or map the task priority. For example, high.

Contact IDs

Select or map the Contact IDs associated with the task.

Status

Select or map the task status. For example, completed.

User ID

Select or map the User ID assigned to the task.

You can GET a list of possible users from Misc/Users

Due at

Enter (map) the date and time by which the task must be complete. See the list of supported date and time formats.

Type

Select or mpa the task type. For example, call.

Note

Enter (map) any additional information or details about the task.

List Tasks

Returns a list of tasks.

Limit Set the maximum number of tasks Ibexa Connect will return during one execution cycle. The default value is 10.

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized API Call.

URL

Enter a path relative to https://api.apollo.io/. For example, /v1/accounts.

Note

For the list of available endpoints, refer to the Apollo API Documentation.

Method

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - List of Account Stages

The following API call returns a list of account stages from your Apollo account:

URL:

/v1/account_stages

Method:

GET

Apollo_5.png

Matches of the search can be found in the module's Output under Bundles > Body > account_stages.

In our example, 5 account stages were returned:

Apollo_6.png