diff --git a/src/destinations/eventbridge.mdx b/src/destinations/eventbridge.mdx deleted file mode 100644 index 29212d2f..00000000 --- a/src/destinations/eventbridge.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Amazon EventBridge destinations ---- - -For more information on destinations, see the [Destinations](/destinations) page. - -When new data is read from a SaaS instance via a [Read Action](/read-actions) or [Subscribe Action](/subscribe-actions), Ampersand publishes the payload as events to your Amazon EventBridge event bus. - -## Prerequisites - -Before setting up an EventBridge destination, ensure that you have: -- An AWS account with an EventBridge event bus -- AWS credentials with `events:PutEvents` permission on that event bus - -## Data format - -Ampersand publishes each read or subscribe message to your event bus. The message payload is carried in the event's `detail` field, and its schema is defined in [webhook.yaml](https://github.com/amp-labs/openapi/blob/main/webhook/webhook.yaml). - -## Create an EventBridge destination - -Go to the [Destinations page](https://dashboard.withampersand.com/projects/_/destinations) in the Ampersand Dashboard and create a new EventBridge destination. - -You'll need to provide: - -| Field | Type | Required | Example | Description | -|-------|------|----------|---------|-------------| -| **Destination name** | string | Yes | `ampersandEventBridge` | Alias to reference in your `amp.yaml` file | -| **Event bus name** | string | Yes | `default` | Name of your EventBridge event bus | -| **Region** | string | Yes | `us-west-2` | AWS region where your event bus is located | -| **AWS Access Key ID** | string | Yes | `AKIAIOSFODNN7EXAMPLE` | AWS access key with `events:PutEvents` permission | -| **AWS Secret Access Key** | string | Yes | | AWS secret access key | -| **Detail type** | string | No | `ampersand.record` | Value to set as the EventBridge `detail-type` on published events | - -## Refer to the destination in your integration - -After creating your EventBridge destination, reference it in your `amp.yaml` file: - -```yaml -specVersion: 1.0.0 -integrations: - - name: salesforceToEventBridge - displayName: Salesforce to EventBridge - provider: salesforce - read: - objects: - - objectName: account - destination: ampersandEventBridge - - objectName: contact - destination: ampersandEventBridge -``` diff --git a/src/destinations/overview.mdx b/src/destinations/overview.mdx index 208f472d..ba756041 100644 --- a/src/destinations/overview.mdx +++ b/src/destinations/overview.mdx @@ -2,7 +2,7 @@ title: Overview --- -Ampersand supports webhook, Slack, Kinesis, and S3 destinations, along with a range of data warehouse and message queue destinations (ClickHouse, Snowflake, BigQuery, Redshift, Amazon SQS, Amazon SNS, Amazon EventBridge, Google Cloud Pub/Sub, and RabbitMQ). Destinations allow you to route data synced from SaaS instances via [Read Actions](/read-actions) or [Subscribe Actions](/subscribe-actions), and to receive real-time [Notifications](/notifications) about important lifecycle events in your projects. +Ampersand supports webhook, Slack, Kinesis, and S3 destinations, along with a range of data warehouse destinations (ClickHouse, Snowflake, BigQuery, and Redshift). Destinations allow you to route data synced from SaaS instances via [Read Actions](/read-actions) or [Subscribe Actions](/subscribe-actions), and to receive real-time [Notifications](/notifications) about important lifecycle events in your projects. ## Add a destination to the Ampersand Dashboard @@ -48,14 +48,9 @@ Destinations can also be used to receive [notifications](/notifications) about i * [BigQuery destinations](/destinations/bigquery) * [Amazon Redshift destinations](/destinations/redshift) -### Message queues and event buses +### Streams * [Amazon Kinesis destinations](/destinations/kinesis) -* [Amazon SQS destinations](/destinations/sqs) -* [Amazon SNS destinations](/destinations/sns) -* [Amazon EventBridge destinations](/destinations/eventbridge) -* [Google Cloud Pub/Sub destinations](/destinations/pubsub) -* [RabbitMQ destinations](/destinations/rabbitmq) ## Other Destinations diff --git a/src/destinations/pubsub.mdx b/src/destinations/pubsub.mdx deleted file mode 100644 index b79003dc..00000000 --- a/src/destinations/pubsub.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Google Cloud Pub/Sub destinations ---- - -For more information on destinations, see the [Destinations](/destinations) page. - -When new data is read from a SaaS instance via a [Read Action](/read-actions) or [Subscribe Action](/subscribe-actions), Ampersand publishes the payload as messages to your Google Cloud Pub/Sub topic. - -## Prerequisites - -Before setting up a Pub/Sub destination, ensure that you have: -- A Google Cloud project with a Pub/Sub topic -- A service account with the `Pub/Sub Publisher` role (or `pubsub.topics.publish` permission) on that topic, and a JSON key for it - -## Data format - -Ampersand publishes each read or subscribe message to your topic as JSON. The full payload schema is defined in [webhook.yaml](https://github.com/amp-labs/openapi/blob/main/webhook/webhook.yaml). - -## Create a Pub/Sub destination - -Go to the [Destinations page](https://dashboard.withampersand.com/projects/_/destinations) in the Ampersand Dashboard and create a new Pub/Sub destination. - -You'll need to provide: - -| Field | Type | Required | Example | Description | -|-------|------|----------|---------|-------------| -| **Destination name** | string | Yes | `ampersandPubSub` | Alias to reference in your `amp.yaml` file | -| **Project ID** | string | Yes | `my-gcp-project` | Google Cloud project ID | -| **Topic ID** | string | Yes | `ampersand-events` | Pub/Sub topic ID | -| **Service account credentials** | string | Yes | | Service account key JSON with publish access to the topic | - -## Refer to the destination in your integration - -After creating your Pub/Sub destination, reference it in your `amp.yaml` file: - -```yaml -specVersion: 1.0.0 -integrations: - - name: salesforceToPubSub - displayName: Salesforce to Pub/Sub - provider: salesforce - read: - objects: - - objectName: account - destination: ampersandPubSub - - objectName: contact - destination: ampersandPubSub -``` diff --git a/src/destinations/rabbitmq.mdx b/src/destinations/rabbitmq.mdx deleted file mode 100644 index 9c873bb4..00000000 --- a/src/destinations/rabbitmq.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: RabbitMQ destinations ---- - -For more information on destinations, see the [Destinations](/destinations) page. - -When new data is read from a SaaS instance via a [Read Action](/read-actions) or [Subscribe Action](/subscribe-actions), Ampersand publishes the payload as messages to your RabbitMQ instance. - -## Prerequisites - -Before setting up a RabbitMQ destination, ensure that you have: -- A RabbitMQ instance reachable from the internet -- A connection URI with permission to publish -- A routing key that reaches a queue you can consume from - -## Data format - -Ampersand publishes each read or subscribe message to your RabbitMQ instance as JSON, using the routing key you configure. The full payload schema is defined in [webhook.yaml](https://github.com/amp-labs/openapi/blob/main/webhook/webhook.yaml). - -## Create a RabbitMQ destination - -Go to the [Destinations page](https://dashboard.withampersand.com/projects/_/destinations) in the Ampersand Dashboard and create a new RabbitMQ destination. - -You'll need to provide: - -| Field | Type | Required | Example | Description | -|-------|------|----------|---------|-------------| -| **Destination name** | string | Yes | `ampersandRabbitMQ` | Alias to reference in your `amp.yaml` file | -| **Connection URI** | string | Yes | `amqp://user:pass@host:5672` | AMQP connection URI (it embeds your credentials) | -| **Routing key** | string | Yes | `ampersand-events` | Routing key to publish messages with | - -## Refer to the destination in your integration - -After creating your RabbitMQ destination, reference it in your `amp.yaml` file: - -```yaml -specVersion: 1.0.0 -integrations: - - name: salesforceToRabbitMQ - displayName: Salesforce to RabbitMQ - provider: salesforce - read: - objects: - - objectName: account - destination: ampersandRabbitMQ - - objectName: contact - destination: ampersandRabbitMQ -``` diff --git a/src/destinations/sns.mdx b/src/destinations/sns.mdx deleted file mode 100644 index e1f19851..00000000 --- a/src/destinations/sns.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Amazon SNS destinations ---- - -For more information on destinations, see the [Destinations](/destinations) page. - -When new data is read from a SaaS instance via a [Read Action](/read-actions) or [Subscribe Action](/subscribe-actions), Ampersand publishes the payload as messages to your Amazon SNS topic. - -## Prerequisites - -Before setting up an SNS destination, ensure that you have: -- An AWS account with an SNS topic -- AWS credentials with `sns:Publish` permission on that topic - -## Data format - -Ampersand publishes each read or subscribe message to your topic as JSON. The full payload schema is defined in [webhook.yaml](https://github.com/amp-labs/openapi/blob/main/webhook/webhook.yaml). - -## Create an SNS destination - -Go to the [Destinations page](https://dashboard.withampersand.com/projects/_/destinations) in the Ampersand Dashboard and create a new SNS destination. - -You'll need to provide: - -| Field | Type | Required | Example | Description | -|-------|------|----------|---------|-------------| -| **Destination name** | string | Yes | `ampersandSNS` | Alias to reference in your `amp.yaml` file | -| **Topic ARN** | string | Yes | `arn:aws:sns:us-east-1:123456789012:my-topic` | ARN of your SNS topic | -| **Region** | string | Yes | `us-west-2` | AWS region where your topic is located | -| **AWS Access Key ID** | string | Yes | `AKIAIOSFODNN7EXAMPLE` | AWS access key with `sns:Publish` permission | -| **AWS Secret Access Key** | string | Yes | | AWS secret access key | -| **Endpoint URL** | string | No | `https://sns.us-east-1.amazonaws.com` | Custom SNS endpoint if applicable | - -## Refer to the destination in your integration - -After creating your SNS destination, reference it in your `amp.yaml` file: - -```yaml -specVersion: 1.0.0 -integrations: - - name: salesforceToSNS - displayName: Salesforce to SNS - provider: salesforce - read: - objects: - - objectName: account - destination: ampersandSNS - - objectName: contact - destination: ampersandSNS -``` diff --git a/src/destinations/sqs.mdx b/src/destinations/sqs.mdx deleted file mode 100644 index bf7598d0..00000000 --- a/src/destinations/sqs.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Amazon SQS destinations ---- - -For more information on destinations, see the [Destinations](/destinations) page. - -When new data is read from a SaaS instance via a [Read Action](/read-actions) or [Subscribe Action](/subscribe-actions), Ampersand publishes the payload as messages to your Amazon SQS queue. - -## Prerequisites - -Before setting up an SQS destination, ensure that you have: -- An AWS account with an SQS queue -- AWS credentials with `sqs:SendMessage` permission on that queue - -## Data format - -Ampersand publishes each read or subscribe message to your queue as JSON. The full payload schema is defined in [webhook.yaml](https://github.com/amp-labs/openapi/blob/main/webhook/webhook.yaml). - -## Create an SQS destination - -Go to the [Destinations page](https://dashboard.withampersand.com/projects/_/destinations) in the Ampersand Dashboard and create a new SQS destination. - -You'll need to provide: - -| Field | Type | Required | Example | Description | -|-------|------|----------|---------|-------------| -| **Destination name** | string | Yes | `ampersandSQS` | Alias to reference in your `amp.yaml` file | -| **Queue URL** | string | Yes | `https://sqs.us-east-1.amazonaws.com/123456789012/my-queue` | URL of your SQS queue | -| **Region** | string | Yes | `us-west-2` | AWS region where your queue is located | -| **AWS Access Key ID** | string | Yes | `AKIAIOSFODNN7EXAMPLE` | AWS access key with `sqs:SendMessage` permission | -| **AWS Secret Access Key** | string | Yes | | AWS secret access key | -| **Endpoint URL** | string | No | `https://sqs.us-east-1.amazonaws.com` | Custom SQS endpoint if applicable | - -## Refer to the destination in your integration - -After creating your SQS destination, reference it in your `amp.yaml` file: - -```yaml -specVersion: 1.0.0 -integrations: - - name: salesforceToSQS - displayName: Salesforce to SQS - provider: salesforce - read: - objects: - - objectName: account - destination: ampersandSQS - - objectName: contact - destination: ampersandSQS -``` diff --git a/src/docs.json b/src/docs.json index 6e5af677..c92314fc 100644 --- a/src/docs.json +++ b/src/docs.json @@ -77,12 +77,7 @@ { "group": "Queues", "pages": [ - "destinations/eventbridge", - "destinations/kinesis", - "destinations/pubsub", - "destinations/rabbitmq", - "destinations/sns", - "destinations/sqs" + "destinations/kinesis" ] } ] diff --git a/src/generate-docs.ts b/src/generate-docs.ts index 40a53080..47ab4f42 100644 --- a/src/generate-docs.ts +++ b/src/generate-docs.ts @@ -308,12 +308,7 @@ const baseConfig = { { group: "Queues", pages: [ - "destinations/eventbridge", "destinations/kinesis", - "destinations/pubsub", - "destinations/rabbitmq", - "destinations/sns", - "destinations/sqs", ] } ]