Ingestion API

You can push data from an external system into Data Cloud with Ingestion API. The Ingestion API Connector lets you connect with Ingestion API.

Ingestion API is a REST API and offers two interaction patterns: bulk and streaming. The streaming pattern accepts incremental updates to a dataset as those changes are captured, while the bulk pattern accepts CSV files in cases where data syncs occur periodically. The same data stream can accept data from the streaming and the bulk interaction.

The process of setting up and configuring Ingestion API includes tasks that must be completed by the admin, the data aware specialist, and the developer. Some tasks must be completed before the information and files are handed off to the next role. The roles involved in each stage could differ within your organization. Here's an overview of how to configure Ingestion API data flow in Data Cloud.

  • Agree on the data to be ingested into Data Cloud and successfully build a file to bring data into Data Cloud.
  • Set up the Ingestion API connector and share the object endpoint details with developers.
  • Create a connected app and align with your developer on the OAuth flow being used to connect to Ingestion API.
  • Create the data streams and deploy them.
  • Make calls to the object endpoints and start sending data into Data Cloud.
  • Map the data to standard Salesforce objects or custom objects.