You will receive notifications via a webhook whenever there are new events associated with a Connection. All webhooks related to connections have a type of CONNECTION.

INITIAL_UPDATE

This webhook fires after an initial data download for a Connection has been completed. You can now send requests to Rutter to fetch merchant data.

{
 "type": "CONNECTION",
 "code": "INITIAL_UPDATE",
 "connection_id": "3adc1519-0d6e-4222-83de-25b457cf42be",
 "access_token": "313c3e00-2bbc-4b2e-a9dc-13abed546b65"
}

HISTORICAL_UPDATE

This webhook fires after all historical data for a Connection has been synchronized. You can continue to fetch data while this process occurs.

{
 "type": "CONNECTION",
 "code": "HISTORICAL_UPDATE",
 "connection_id": "3adc1519-0d6e-4222-83de-25b457cf42be",
 "access_token": "313c3e00-2bbc-4b2e-a9dc-13abed546b65"
}

CONNECTION_UPDATED

This webhook fires after a merchant re-authenticates an existing Connection, or after completing authentication for a created connection. The access_token value stays the same even if the Connection is updated.

{
 "type": "CONNECTION",
 "code": "CONNECTION_UPDATED",
 "connection_id": "3adc1519-0d6e-4222-83de-25b457cf42be",
 "access_token": "313c3e00-2bbc-4b2e-a9dc-13abed546b65",
 "store_unique_id": "AWMFIE33LD"
}

CONNECTION_NEEDS_UPDATE

This webhook fires after a merchant unauthorizes/uninstalls an existing Connection, or if the authentication fails for any other reason. The webhook payload includes a URL that you can share directly with the merchant to re-authenticate them.

{
 "type": "CONNECTION",
 "code": "CONNECTION_NEEDS_UPDATE",
 "connection_id": "3adc1519-0d6e-4222-83de-25b457cf42be",
 "access_token": "313c3e00-2bbc-4b2e-a9dc-13abed546b65",
 "update_url": "https://link.rutterapi.com/connection/3adc1519-0d6e-4222-83de-25b457cf42be"
}

CONNECTION_DISABLED

This webhook fires after Rutter has encountered a problem with a connection and has temporarily disabled access to it.

{
 "type": "CONNECTION",
 "code": "CONNECTION_DISABLED",
 "connection_id": "3adc1519-0d6e-4222-83de-25b457cf42be",
 "access_token": "313c3e00-2bbc-4b2e-a9dc-13abed546b65",
}

CONNECTION_LINK_ERROR

This webhook fires after an error occurs during the authentication process. The webhook payload includes some human-readable details around the error, and a URL that you can share directly with the merchant to re-authenticate them.

{
 "type": "CONNECTION",
 "code": "CONNECTION_LINK_ERROR",
 "connection_id": "3adc1519-0d6e-4222-83de-25b457cf42be",
 "access_token": "313c3e00-2bbc-4b2e-a9dc-13abed546b65",
 "update_url": "https://link.rutterapi.com/connection/3adc1519-0d6e-4222-83de-25b457cf42be",
 "message": "The merchant denied access during OAuth",
 "platform": "SHOPIFY"
}

CONNECTION_ERROR

This webhook after an error occurs for a connection. Errors can be related to data synchronization or issues connecting to a merchant's store after authentication is complete. The error message will contain information about the connection issue.

{
 "type": "CONNECTION",
 "code": "CONNECTION_ERROR",
 "connection_id": "3adc1519-0d6e-4222-83de-25b457cf42be",
 "access_token": "313c3e00-2bbc-4b2e-a9dc-13abed546b65",
 "message": "Cloudflare is enabled on this store and Rutter requests are blocked.",
}