API destination partners - Amazon EventBridge

API destination partners

Use the information provided by the following AWS Partners to configure an API destination and connection for their service or application.

Confluent

API destination invocation endpoint URL:

Typically the following format:

https://random-id.region.aws.confluent.cloud:443/kafka/v3/clusters/cluster-id/topics/topic-name/records

For more information, see Find the REST endpoint address and cluster ID in the Confluent documentation.

Supported authorization types:

Basic

Additional authorization parameters required:

Not applicable

Confluent documentation:

Produce Records

Confluent REST Proxy for Apache Kafka

Commonly used API operations:

POST

Additional information:

To transform the event data into a message that the endpoint can process, create a target input transformer.

  • To generate a record without specifying a Kafka partitioning key, use the following template for your input transformer. No input path is required.

    { "value":{ "type":"JSON", "data":aws.events.event.json }, }
  • To generate a record using an event data field as the Kafka partitioning key, follow the input path and template example below. This example defines the input path for the orderId field, and then specifies that field as the partition key.

    First, define the input path for the event data field:

    { "orderId":"$.detail.orderId" }

    Then, use the input transformer template to specify the data field as the partition key:

    { "value":{ "type":"JSON", "data":aws.events.event.json }, "key":{ "data":"<orderId>", "type":"STRING" } }

Coralogix

API destination invocation endpoint URL

For a full list of endpoints, see Coralogix API Reference.

Supported authorization types

API Key

Additional authorization parameters required

Header "x-amz-event-bridge-access-key", the value is the Coralogix API Key

Coralogix documentation

Amazon EventBridge authentication

Commonly used API operations

US: https://ingress.coralogix.us/aws/event-bridge

Singapore: https://ingress.coralogixsg.com/aws/event-bridge

Ireland: https://ingress.coralogix.com/aws/event-bridge

Stockholm: https://ingress.eu2.coralogix.com/aws/event-bridge

India: https://ingress.coralogix.in/aws/event-bridge

Additional information

The events are stored as log entries with applicationName=[AWS Account] and subsystemName=[event.source].

Datadog

API destination invocation endpoint URL

For a full list of endpoints, see Datadog API Reference.

Supported authorization types

API Key

Additional authorization parameters required

None

Datadog documentation

Authentication

Commonly used API operations

POST https://api.datadoghq.com/api/v1/events

POST https://http-intake.logs.datadoghq.com/v1/input

Additional information

Endpoint URLs differ depending on the location of your Datadog organization. For the correct URL for your organization, see documentation.

Freshworks

API destination invocation endpoint URL

For a list of endpoints, see https://developers.freshworks.com/documentation/

Supported authorization types

Basic, API Key

Additional authorization parameters required

Not applicable

Freshworks documentation

Authentication

Commonly used API operations

https://developers.freshdesk.com/api/#create_ticket

https://developers.freshdesk.com/api/#update_ticket

https://developer.freshsales.io/api/#create_lead

https://developer.freshsales.io/api/#update_lead

Additional information

None

MongoDB

API destination invocation endpoint URL

https://data.mongodb-api.com/app/App ID/endpoint/

Supported authorization types

API Key

Email/Password

Custom JWT Authentication

Additional authorization parameters required

None

MongoDB documentation

Atlas Data API

Endpoints

Custom HTTPS Endpoints

Authentication

Commonly used API operations

None

Additional information

None

New Relic

API destination invocation endpoint URL

For more information, see Our EU and US region data centers.

Events

US– https://insights-collector.newrelic.com/v1/accounts/YOUR_NEW_RELIC_ACCOUNT_ID/events

EU– https://insights-collector.eu01.nr-data.net/v1/accounts/YOUR_NEW_RELIC_ACCOUNT_ID/events

Metrics

US– https://metric-api.newrelic.com/metric/v1

EU– https://metric-api.eu.newrelic.com/metric/v1

Logs

US– https://log-api.newrelic.com/log/v1

EU– https://log-api.eu.newrelic.com/log/v1

Traces

US– https://trace-api.newrelic.com/trace/v1

EU– https://trace-api.eu.newrelic.com/trace/v1

Supported authorization types

API Key

New Relic documentation

Metric API

Event API

Log API

Trace API

Commonly used API operations

Metric API

Event API

Log API

Trace API

Additional information

Metric API limits

Event API limits

Log API limits

Trace API limits

Operata

API destination invocation endpoint URL:

https://api.operata.io/v2/aws/events/contact-record

Supported authorization types:

Basic

Additional authorization parameters required:

None

Operata documentation:

How do I create, view, change and revoke API Tokens?

Operata AWS Integration using Amazon EventBridge Scheduler Pipes

Commonly used API operations:

POST https://api.operata.io/v2/aws/events/contact-record

Additional information:

The username is the Operata Group ID and the password is your API token.

Salesforce

API destination invocation endpoint URL

Sobject– https:// myDomainName.my.salesforce.com/services/data/versionNumber/sobjects /SobjectEndpoint/*

Custom platform events– https://myDomainName.my.salesforce.com/services/data /versionNumber/sobjects/customPlatformEndpoint/*

For a full list of endpoints, see Salesforce API Reference

Supported authorization types

OAuth client credentials

OAUTH tokens are refreshed when a 401 or 407 response is returned.

Additional authorization parameters required

Salesforce Connected App Client Id and Client Secret.

One of the following authorization endpoints:

  • Production– https://MyDomainName.my.salesforce.com./services/oauth2/token

  • Sandbox without enhanced domains– https://MyDomainName-- SandboxName.my. salesforce.com/services /oauth2/token

  • Sandbox with enhanced domains– https://MyDomainName-- SandboxName.sandbox.my.salesforce.com/services/oauth2/token

The following key/value pair:

Key Value

grant_type

client_credentials

Salesforce documentation

REST API Developer Guide

Commonly used API operations

Working with Object Metadata

Working with Records

Additional information

For a tutorial explaining how to use the EventBridge console to create a connection to Salesforce, an API Destination, and a rule to route information to Salesforce, see Tutorial: Create a connection to Salesforce as an API destination.

Slack

API destination invocation endpoint URL

For a list of endpoints and other resources, see Using the Slack Web API

Supported authorization types

OAuth 2.0

OAUTH tokens are refreshed when a 401 or 407 response is returned.

When you create a Slack application and install it to your workspace, an OAuth bearer token will be created on your behalf to be used for authenticating calls by your API destination connection.

Additional authorization parameters required

Not applicable

Slack documentation

Basic app setup

Installing with OAuth

Retrieving messages

Sending messages

Sending messages using Incoming Webhooks

Commonly used API operations

https://slack.com/api/chat.postMessage

Additional information

When configuring your EventBridge rule there are two configurations to highlight:

  • Include a header parameter that defines the content type as “application/json;charset=utf-8”.

  • Use an input transformer to map the input event to the expected output for the Slack API, namely ensure that the payload sent to the Slack API has “channel” and “text” key/value pairs.

Shopify

API destination invocation endpoint URL

For a list of endpoints and other resouces and methods, see Endpoints and requests

Supported authorization types

OAuth, API Key

Note

OAUTH tokens are refreshed when a 401 or 407 response is returned.

Additional authorization parameters required

Not applicable

Shopify documentation

Authentication and authorization overview

Commonly used API operations

POST - /admin/api/2022-01/products.json

GET - admin/api/2022-01/products/{product_id}.json

PUT - admin/api/2022-01/products/{product_id}.json

DELETE - admin/api/2022-01/products/{product_id}.json

Additional information

Create an app

Amazon EventBridge webhook delivery

Access tokens for custom apps in the Shopify admin

Product

Shopify Admin API

Splunk

API destination invocation endpoint URL

https://SPLUNK_HEC_ENDPOINT:optional_port/services/collector/raw

Supported authorization types

Basic, API Key

Additional authorization parameters required

None

Splunk documentation

For both authorization types, you need an HEC token ID. For more information, see Set up and use HTTP Event Collector in Splunk Web.

Commonly used API operations

POST https://SPLUNK_HEC_ENDPOINT:optional_port/services/collector/raw

Additional information

API Key – When configuring the endpoint for EventBridge, the API key name is “Authorization” and value is the Splunk HEC token ID.

Basic (Username/Password) – When configuring the endpoint for EventBridge, the username is “Splunk” and the password is the Splunk HEC token ID.

Sumo Logic

API destination invocation endpoint URL

HTTP Log and Metric Source endpoint URLs will be different for every user. For more information, see HTTP Logs and Metrics Source.

Supported authorization types

Sumo Logic doesn’t require authentication on their HTTP Sources because there’s a unique key baked into the URL. For this reason, you should make sure to treat that URL as a secret.

When you configure the EventBridge API destination, an authorization type is required. To meet this requirement, select API Key and give it a key name of “dummy-key” and a key value of “dummy-value”.

Additional authorization parameters required

Not applicable

Sumo Logic documentation

Sumo Logic has already built hosted sources to collect logs and metrics from many AWS services and you can use the information on their website to work with those sources. For more information, see Amazon Web Services.

If you’re generating custom events from an application and want to send them to Sumo Logic as either logs or metrics, then use EventBridge API Destinations and Sumo Logic HTTP Log and Metric Source endpoints.

Commonly used API operations

POST https://endpoint4.collection.us2.sumologic.com/receiver/v1/http/UNIQUE_ID_PER_COLLECTOR

Additional information

None

TriggerMesh

API destination invocation endpoint URL

Use the information in the Event Source for HTTP topic to formulate the endpoint URL. An endpoint URL includes the event source name and user namespace in the following format:

https://source-name.user-namespace.cloud.triggermesh.io

Include the Basic authorization parameters in the request to the endpoint.

Supported authorization types

Basic

Additional authorization parameters required

None

TriggerMesh documentation

Event Source for HTTP

Commonly used API operations

Not applicable

Additional information

None

Zendesk

API destination invocation endpoint URL

https://developer.zendesk.com/rest_api/docs/support/tickets

Supported authorization types

Basic, API Key

Additional authorization parameters required

None

Zendesk documentation

Security and Authentication

Commonly used API operations

POST https://your_Zendesk_subdomain/api/v2/tickets

Additional information

API requests EventBridge makes count against your Zendesk API limits. For information about Zendesk limits for your plan, see Usage limits.

To better safeguard your account and data, we recommend using an API key rather than basic sign-in credentials authentication.