Edge API References

Calling all automation enthusiasts! 

Some tasks take up a lot of time during your busy day. We rely on automation to ease this time sink by automating otherwise manual tasks triggered by a condition.

Table of Contents

• What is Edge API? Which Endpoints are Available?
• Generating and Managing Your Tokens
• How to Execute/Test an Endpoint
• Example Request in Postman
• Response Code Statuses
• Notes

What is Edge API? Which Endpoints are Available?

Our Edge API, named this way due to the subdomain used to access it, is a series of endpoints that an admin can use to create either one-off requests or automated actions.

Using JSON or basic ID numbers, you can perform various actions on several assets. These endpoints are categorized into the following sections. You can also refer to our API References documentation for further details. You can find the full list of endpoints here.

Health

• Monitor the health of your application

Tenant

• Your organization's tenant ID

Rule

• Create/Update/Delete and List of Rules for the tenant

Workspace

• Read all workspaces
• Remove users from a workspace
• Remove users from all workspaces
• Add users to a workspace
• Read all users (or in a workspace)

Team

• Remove users from a team
• Remove users from all teams (within workspaces or from all workspaces)
• Add users to a team
• Read all teams

Distribution

• Update the Distribution and publish it
• Delete distribution
• List all distributions

Availability

• Gets available slots of assignees in round-robin meetings

User

• Updates licenses for users
• Invites new users to the organization
• Read user information
• Find user

CRM

• Activity via CRM event ID
• Cancel a CRM event via CRM event ID
• No show at a CRM meeting via CRM event ID

Meetings

• Activity
• Cancel a meeting
• No show for a meeting
• Query the list of meetings
• Get a meeting by id
• Export meetings into CSV

Concierge

• Read Concierge logs
• List Concierge routers
• Route a lead by router slug (returns a booking URL; optionally returns time slots for direct scheduling)
• Route a lead without a slug (router resolved from the request body)
• Schedule a meeting from a routing session

Scheduling Links

• List personal scheduling links
• List personal scheduling link URLs (deprecated)
• List round robin scheduling links
• List admin (one-on-one) scheduling links
• List group scheduling links
• List ownership scheduling links
• Initialize a scheduling session for a scheduling link
• Schedule a meeting from a scheduling session

Handoff

• Initialize a handoff flow for a workspace (evaluate routing and return available slots)
• Schedule a meeting from a handoff session

Generating and Managing Your Tokens

If you plan on automating, you must have session tokens generated to ensure you have access to them.

Generate a new Token:

1. In the Command Center, navigate to Integrations:
   
2. Then, access the API Access Tokens
3. There, you can use the Generate Token button to create a new one.
4. A pop-up will prompt you to select a name for your Token. Once ready, click Next.
   
5. Next, select which permissions this Token will have (Ping, Modify, Read, Remove) and under which sections. Once ready, click Generate.
   
6. The Token will be generated. Be sure to copy and save it, as you won't be able to copy it later.
   

Managing and Deleting Tokens

Within the same page, you will see a list of generated Tokens for your org alongside useful data such as Last Access, Created Date, and Created By.

You can also click the three dots (...) to view the Token's permissions and Remove and Delete.

Note that once you delete a Token, it will also revoke view, update, and manage access to your organization's data for that Token.

How to Execute/Test an Endpoint

You can run the endpoint directly via a cURL request or with an app such as Postman. Each endpoint is appended by https://fire.chilipiper.com. You can also utilize these requests in automation apps such as Zapier (as webhooks).

Use the API references to determine the schema/formatting of each request

Swagger UI

You can also use this Swagger UI, where you can test and execute the APIs:

1. Expand the section you want to test
2. 
3. 
4. Click "Execute," and the execution response will be displayed.

Finding your Assets IDs

You will notice in the API References page that, within some Payloads, an ID will be required for testing or executing APIs.

Workspace

In the Command Center's Workspace page, click Open next to the one you want to collect the ID.

Team

Distribution

Users

In the Command Center's Users Table page, click Open next to an active user.

CRM

The crmEventId will be mostly grabbed from your CRM instance's Events.

Meetings

Example Request in Postman

Response Code Statuses

200 - Request successful
404 - ID was not found, or URL cannot be accessed
400 - Bad request. Check the syntax of the request so that it matches our schema

401 / 500 - These usually indicate the user does not have permission to execute the request

Notes

• When executing a query to retrieve a large number of records, the maximum number of records that can be returned in the response is 100.
  • The default response will return 50 records if no value is provided by the caller
  • Any caller can cycle through however many pages they want, each with up to 100 records.
  • A query string parameter ?pageSize=100 can be appended to the endpoints' response.
  • We supply a 'nextPage' endpoint value at the end of the request to paginate through the response payload.