Rebrand 2023 Learn more 

  • Integrations (Event Subscriptions/Notifications)/
    Integrations API/
    Integrations API Overview

    Integrations API Overview

    You can integrate Commerce with your external systems like enterprise resource planning, order management, fulfilment, and other systems, ensuring that buying is quick and easy for your shoppers.

    With integrations, you can trigger custom code, which performs actions outside of the Commerce ecosystem, from observable events. Events can be delivered in a number of ways, such as a webhook or a message queuing service like Amazon SQS. For example, you can send a discount code or a Net Promoter Score (NPS) survey email a few days after an order is fulfilled. You can do this through a webhook that sends event data to your custom function, or by sending a message that is delivered to your message queue.

    Events are processed concurrently. This means that events may not be delivered in the order they are created. For example, if the status of an order is updated multiple times, the events may not be delivered in the same sequence they were updated. Integration events operate on an "at least once" delivery policy. We aim to deliver messages within 30 minutes or less. Ensure that you design your receiving code accordingly.

    Integration Object

    idstringSpecifies the unique identifier for the integration.
    typestringRepresents the type of object being returned.
    namestringSpecifies the name of the integration.
    descriptionstringSpecifies a description for the integration.
    integration_typestringSpecifies how the integration is delivered, either webhook, aws_sqs, or stomp
    enabledbooleanSpecifies whether the integration is enabled.
    observesarray[string]Specifies an array of observable events.
    configurationobjectSpecifies a configuration object.
    Integration Payload