Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1438230222.0 KB

Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.

An integration can belong to only one domain.

To add or remove tags on an existing Integration, see TagResource / UntagResource.

put/domains/{DomainName}/integrations

Path parameters

DomainNamestring required

The unique name of the domain.

Request body

Uristring

The URI of the S3 bucket or any other type of data source.

ObjectTypeNamestring

The name of the profile object type.

Tagsobject

The tags used to organize, track, or control access for this resource.

ObjectTypeNamesobject

A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event. It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>, <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.

Response

Success

DomainNamestring required

The unique name of the domain.

Uristring required

The URI of the S3 bucket or any other type of data source.

ObjectTypeNamestring

The name of the profile object type.

CreatedAtstring date-time required

The timestamp of when the domain was created.

LastUpdatedAtstring date-time required

The timestamp of when the domain was most recently edited.

Tagsobject

The tags used to organize, track, or control access for this resource.

ObjectTypeNamesobject

A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event. It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>, <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.

WorkflowIdstring

Unique identifier for the workflow.

IsUnstructuredboolean

Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.