diff --git a/src/destinations/azure-blob.mdx b/src/destinations/azure-blob.mdx new file mode 100644 index 00000000..fb251e6a --- /dev/null +++ b/src/destinations/azure-blob.mdx @@ -0,0 +1,49 @@ +--- +title: Azure Blob Storage 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 writes the payload as objects to your Azure Blob Storage container. + +## Prerequisites + +Before setting up an Azure Blob Storage destination, ensure that you have: +- An Azure Storage account +- A blob container to write to +- The storage account's access key + +## Data format + +Ampersand writes each read or subscribe message as a JSON object to your container. The full payload schema is defined in [webhook.yaml](https://github.com/amp-labs/openapi/blob/main/webhook/webhook.yaml). + +## Create an Azure Blob Storage destination + +Go to the [Destinations page](https://dashboard.withampersand.com/projects/_/destinations) in the Ampersand Dashboard and create a new Azure Blob Storage destination. + +You'll need to provide: + +| Field | Type | Required | Example | Description | +|-------|------|----------|---------|-------------| +| **Destination name** | string | Yes | `ampersandAzureBlob` | Alias to reference in your `amp.yaml` file | +| **Account** | string | Yes | `mystorageaccount` | Azure Storage account name | +| **Container** | string | Yes | `ampersand-data` | Blob container to write objects to | +| **Access key** | string | Yes | | Storage account access key | + +## Refer to the destination in your integration + +After creating your Azure Blob Storage destination, reference it in your `amp.yaml` file: + +```yaml +specVersion: 1.0.0 +integrations: + - name: salesforceToAzureBlob + displayName: Salesforce to Azure Blob Storage + provider: salesforce + read: + objects: + - objectName: account + destination: ampersandAzureBlob + - objectName: contact + destination: ampersandAzureBlob +``` diff --git a/src/destinations/gcs.mdx b/src/destinations/gcs.mdx new file mode 100644 index 00000000..9c4566c5 --- /dev/null +++ b/src/destinations/gcs.mdx @@ -0,0 +1,47 @@ +--- +title: Google Cloud Storage 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 writes the payload as objects to your Google Cloud Storage bucket. + +## Prerequisites + +Before setting up a Google Cloud Storage destination, ensure that you have: +- A Google Cloud project with a Cloud Storage bucket +- A service account with the `Storage Object Creator` role (or `storage.objects.create` permission) on that bucket, and a JSON key for it + +## Data format + +Ampersand writes each read or subscribe message as a JSON object to your bucket. The full payload schema is defined in [webhook.yaml](https://github.com/amp-labs/openapi/blob/main/webhook/webhook.yaml). + +## Create a Google Cloud Storage destination + +Go to the [Destinations page](https://dashboard.withampersand.com/projects/_/destinations) in the Ampersand Dashboard and create a new Google Cloud Storage destination. + +You'll need to provide: + +| Field | Type | Required | Example | Description | +|-------|------|----------|---------|-------------| +| **Destination name** | string | Yes | `ampersandGCS` | Alias to reference in your `amp.yaml` file | +| **Bucket** | string | Yes | `ampersand-integration-bucket` | Name of your Cloud Storage bucket | +| **Service account credentials** | string | Yes | | Service account key JSON with write access to the bucket | + +## Refer to the destination in your integration + +After creating your Google Cloud Storage destination, reference it in your `amp.yaml` file: + +```yaml +specVersion: 1.0.0 +integrations: + - name: salesforceToGCS + displayName: Salesforce to Google Cloud Storage + provider: salesforce + read: + objects: + - objectName: account + destination: ampersandGCS + - objectName: contact + destination: ampersandGCS +``` diff --git a/src/destinations/overview.mdx b/src/destinations/overview.mdx index 208f472d..50719061 100644 --- a/src/destinations/overview.mdx +++ b/src/destinations/overview.mdx @@ -40,6 +40,8 @@ Destinations can also be used to receive [notifications](/notifications) about i ### Blob storage * [Amazon S3 destinations](/destinations/s3) +* [Azure Blob Storage destinations](/destinations/azure-blob) +* [Google Cloud Storage destinations](/destinations/gcs) ### Databases and warehouses diff --git a/src/docs.json b/src/docs.json index 6e5af677..cddb738f 100644 --- a/src/docs.json +++ b/src/docs.json @@ -62,6 +62,8 @@ { "group": "Blob storage", "pages": [ + "destinations/azure-blob", + "destinations/gcs", "destinations/s3" ] }, diff --git a/src/generate-docs.ts b/src/generate-docs.ts index 40a53080..ad9e9280 100644 --- a/src/generate-docs.ts +++ b/src/generate-docs.ts @@ -293,6 +293,8 @@ const baseConfig = { { group: "Blob storage", pages: [ + "destinations/azure-blob", + "destinations/gcs", "destinations/s3", ] },