Salesloft Developer Documentation

website·Indexed 43 days ago

https://developer.salesloft.com

Documentation for the Salesloft Public API v1 and platform integrations. Includes guides for managing people, companies, cadences, and calls, as well as resources for Cadence Imports, Rhythm plays, and the Salesloft Marketplace partner program.

Tokens
50.9K
Snippets
325
Records
464
Agent score
48%

What's inside Salesloft

  1. Overview of Salesloft Frontend Integration connection points

    Salesloft Frontend Integrations allow developers to embed their application experience into Salesloft using iframe connection points. Each connection point is a distinct iframe URL. Available connection points include:

    • Full Page: Provides a full page of content accessible via an integration navigation component.
    • Person Smart Panel: Appears on the person detail page; can be reorganized or hidden by the user.
    • Account Smart Panel: Appears on the account detail page; can be reorganized or hidden by the user.
    • Email & Template Editor: Adds a toolbar list entry to the email and template editor (used for sending emails, signatures, snippets, and templates). This integration can insert HTML directly into the editor.
    • Custom Steps: Adds a step that can be included in any team cadence. These steps appear in the user's task list and must use the Salesloft REST API to complete actions.
  2. Overview of Salesloft External ID Mapping

    Salesloft allows enterprises to map one or multiple unique identifiers from an external system of record to Salesloft objects. This is used to identify and request Salesloft People (Buyers), Accounts (Companies), and Users (Sellers) using external IDs instead of internal Salesloft IDs. This is particularly useful for custom CRM integrations or when deprecating the use of custom fields to store external IDs.
  3. Overview of Salesloft External Calendar Integration

    The External Calendar integration allows organizations to enable Salesloft meeting capabilities while maintaining complete control over the calendar data passed to Salesloft. Unlike standard integrations that require full calendar access, this method requires the integration to perform bi-directional synchronization between Salesloft's simplified calendar and the user's actual calendar.

    The integration is responsible for three primary tasks:

    1. Managing meeting settings for individual users to activate or disable the integration.
    2. Maintaining the user's calendar state to ensure accurate availability within Salesloft services.
    3. Syncing meetings created in Salesloft by placing them onto the user's real calendar.
  4. Overview of the Salesloft API Logs Dashboard

    The API Logs Dashboard allows Salesloft users to monitor API calls made by installed integrations and active API Keys. It is designed for self-service troubleshooting, visibility, and governance, enabling users to identify which integrations are accessing data, track rate limit usage, and analyze error patterns.
  5. Understand Salesloft Bulk Jobs constraints and behavior

    Bulk jobs in Salesloft allow for asynchronous access and modification of large quantities of data. Key operational constraints include:

    • Sequential Processing: Only one bulk job is processed at a time per tenant. Subsequent jobs are queued and start only after the current job completes.
    • Concurrency: This endpoint is not suitable for time-sensitive tasks or high-concurrency requirements; it is designed for completing one job at a time.
    • Rate Limiting: Standard rate limits apply to the initial call to the bulk_jobs endpoint, but no additional rate limits are applied to the bulk operation once execution has begun.
    • Data Retention: Row-by-row results are deleted 30 days after creation for privacy compliance. While job counts are preserved, the detailed job data becomes unavailable after this period.

    For time-sensitive jobs or tasks requiring immediate attention, use the appropriate single-resource endpoints instead of the bulk jobs endpoint.

  6. Integrate custom content into the Salesloft Person detail page

    Person smart panel integrations allow developers to add custom data or behavior directly into the Salesloft person detail page. These integrations are rendered within an iframe. Users have the ability to reorder these panels based on preference or hide them entirely, including the option to prioritize a custom integration by placing it at the top of the list.
  7. Understand Salesloft API response structure

    All Salesloft API responses with a body follow a consistent basic format using these primary keys:

    • data: The root key containing all returned resource data.
    • metadata: Contains information about the specific request. For 'list' requests, this includes the filtering, paging, and sorting parameters used to process the request.
  8. Send recommended email content via Salesloft Signals API

    The Signals API allows integrations to include a recommended email subject and body within a signal. If the signal meets the criteria of an enabled Rhythm play and a task is created, Salesloft will use this recommended content for the seller's task.

    Key Constraints:

    • Content is only used when a Salesloft task is created by an enabled play.
    • This flow is optimized for signals using person attribution; integrations should typically resolve the Person via v2/people before sending the signal.
  9. Register external object updates as Salesloft Signals via IPaaS

    Salesloft allows users to leverage data from external systems (such as external databases or product adoption/usage sources) through an IPaaS solution to trigger automated workflows and create tasks for sales teams using Salesloft Plays. This is particularly useful for data that does not reside in the CRM. While the framework supports various IPaaS platforms, it specifically highlights integrations with Tray.ai, Workato, and Zapier.
  10. Retrieve the currently authenticated user profile

    Use the /v2/me endpoint to fetch information about the user currently authenticated with the API. This endpoint does not accept any parameters because it implicitly identifies the user based on the authentication credentials provided in the request. For retrieving information about other users on a team, use the 'Users' resource instead.
    curl -X GET "https://api.salesloft.com/v2/me"
  11. Implement an Account Smart Panel integration in Salesloft

    Account smart panel integrations allow you to embed custom data or behavior directly into the Salesloft account detail page. These integrations are rendered within an iframe. Users have the ability to reorder these panels based on preference or hide them entirely. To ensure a good user experience, integrations must be responsive, as the panel width is fluid based on the user's screen size. The current default height for the iframe is 320px, though this may change in future updates.
  12. Understand the Call Data Record endpoint

    The Call Data Record endpoint exposes information about calls made using the Salesloft Dialer. It tracks whether the call was recorded and whether it was logged in the system. Note that a Call Data Record is only generated when the Salesloft Dialer is used; manual logs without the dialer will not have an associated record here.