Create an Event Ingestion Integration
Prework requirements
This guide assumes that you've completed the prerequisites for building partner integrations listed in Amplitude Integration Portal. Amplitude disables event ingestion integration creation by default. To create an event ingestion integration, send an email to integrations@amplitude.com with your [Org ID].
This guide walks through the basics of creating an event ingestion integration in Amplitude. This guide doesn't cover how to build your integration or send events to Amplitude. For information about sending events to Amplitude, refer to the HTTP v2 API documentation.
- Navigate to Settings > Developer Portal.
- Click Add Connection Info.
- Enter the connection information:
- Display Name: The display name of the integration. This is the name that appears in the Integration Catalog and on your integration tile.
- Category: Choose a category. The Integration Catalog uses the category in filters.
- Summary: A brief overview of your product.
- Full Description: Detailed description of your integration. Include common use cases so users understand why they should use the integration.
- Integration Logo: Upload your integration logo in PNG format.
Integration setup
Configure the integration tile that appears on the Sources page in Amplitude after Amplitude validates your integration.
The page has two sections:
Left Panel: The Configuration section on the left is where you create the setup instructions for your data source and configure your integration tile.
Right Panel: The Preview Data Source Setup Page section shows what your setup instructions look like for a user.
- From the Integration Portal page (Settings > Developer Portal), click Add New Source.
- The Connection Information section controls the Display Name.
- Enter a subtitle. This appears under the title when the user sets up the integration.
Example subtitles
- If you use Braze, you can now send events to Amplitude. - If you use RudderStack to ingest data, you can import events into Amplitude with a few steps. - If you use Split for feature flagging and experimentation, you can track data into Amplitude with a simple configuration.- Add as many setup steps as you need, but aim for no more than 5 to 8. You can include images that orient your users. Mark Show Project API Key to automatically pull the relevant Project API on behalf of the user. You configure all sources and destinations for Amplitude on the project level, not the organization level.
View example setup steps in Amplitude
Navigate to Data Sources and click I want to import data into Amplitude. From there, click any integration tile to view its setup instructions.
- In Additional Resources, add a link to your documentation. For example:
Refer to the Amplitude [documentation](/docs/) for more details and instructions. - When finished, click Next to go to the testing tab.
Test and submit the integration
After you configure your source information, you can test it and submit it for review.
- From the Test Source tab, select the Amplitude project to test the integration with.
- Copy the value in Assigned Partner ID for this Source Integration. You must include this value in a
partner_idparameter when sending events to Amplitude. Amplitude needs this to track events coming from partners and validate the number of integration users. - Send a test event from your system.
Example payload
POST https://api2.amplitude.com/2/httpapi
{
"api_key": "2a0d30356cbb278eee1a69b2bbe81c37",
"events": [
{
"user_id": "test@example.com",
"partner_id": "integration_name",
"event_type": "Product Viewed",
"time": 1663940508564,
"event_properties": {
"message_type": "push",
"message_title": "Sample Message title",
"message_id": "68b32868-b6ab-4511-b552-cf668a1c0e59",
"message_contents": "Sample message content"
}
}
]
}
```
{% /callout %}
4. Wait for Amplitude to verify the event.
After you finish testing, click **Submit** to submit your integration to the Amplitude team. The review process takes about one week. When Amplitude approves your integration, Amplitude notifies you by email and your integration tile appears in the Sources section of Amplitude.
Was this helpful?