Automate Webhook Subscription on Marketplace

Open

The Below Table explains the description of each Block present in Sequence Diagram

Step 1. The POST endpoint “listener/automatewebhook “ will receive an eventMap from the PubSub topic “automationWebhook“. The event will be:

Step 2. Push the eventMap received from PubSub topic in TaskQueue.

Step 3. Return a 200 Ok response back to Pubsub from “listener/automatewebhook “ endpoint.

Step 4. “listen/taskQueueEvent“ this endpoint will receive the data from WebhookTaskQueue(This is not the default TaskQueue).

Step 5. Extract the “integrationType” from the event received from WebhookTaskQueue

Step 6. Depending upon the integrationType call the respective method to register Webhook.

As of now we have to Automate Webhook Subscription for two channels’s

Step 6.1 integrationType = 7 corresponds to shopify so call method “prepareShopifyWebhook“ and extract“connectionId” from the data received from TaskQueue, using connectionId extract connectionDetails from DB only if it is not present in cache and then set them in cache.

Step 6.1.1 Extract accessToken and store_name from the connectionDetails and prepare webhook request body. There are 4 topics for shopify: "orders/create" , "orders/cancelled", "product_listings/add", "product_listings/update", prepare webhook request body and Eshopbox Webhook EndPoint URL for each topic in the given format:

Template for Eshopbox Webhook URL for Shopify on staging:

Template for Eshopbox Webhook URL for Shopify on prod:

Template for Shopify Webhook Registration Request Body:

Webhook Registration Request Body for Shopify on staging:

1. Topic: “orders/create”

2. Topic: “orders/cancelled”

3. Topic: “product_listings/update“

4. Topic: “product_listings/add“

Webhook Registration Request Body for Shopify on prod:

1. Topic: “orders/create“

2. Topic: “orders/cancelled”

3. Topic: “product_listings/update“

4. Topic: “product_listings/add“

Step 6.1.2 Prepare the Shopify Webhook Registration Endpoint URL at which the request body will be send

Template for webhook register URL:

Step 6.1.3 Register the webhook for each topic on shopify by making a post request on the above prepared URL by passing accessToken and webhook request body.

Step 6.2 integrationType = “8“ corresponds to amazon prime so call method “prepareAmazonPrimeWebhook“

Step 6.2.1 Extract amz Access Token using Amazon SDK Library Method only if not present in cache and then set it in cache. Prepare webhook request body for the topics “Orders.Created“, “Orders.Cancelled“, “Orders.Delivered“, “Orders.Updated“ using the below format:

Template for creating Eshopbox Webhook URL for Amazon on staging:

Template for creating Eshopbox Webhook URL for Amazon on prod :

Template for creating Webhook Registration Request Body for Amazon:

Webhook Registration Request Body for Amazon on staging:

1. Topic: “Orders.Created“

   { "destination":"arn:aws:events:eu-west-1:460481696846:event-bus/Sandbox", "events":[ "Orders.Created" ] }

2. Topic: “Orders.Cancelled”

3. Topic: “Orders.Delivered”

4. Topic: “Orders.Updated”

Webhook Registration Request Body for Amazon on prod:

1. Topic: “Orders.Created“

2. Topic: “Orders.Cancelled”

3. Topic: “Orders.Delivered”

4. Topic: “Orders.Updated”

Step 6.2.2 Once the request body is prepared make a request to register the webhook for events (“Orders.Created”, “Orders.Cancelled“, “Orders.Delivered“, “Orders.Updated“) on Amazon. These subscriptions are created using Amazon SDK library Method:

1. Create Event Subscription:

EventSubscription Request Body: Convert the below prepared Webhook Request Body into the EventSubscription model.

(Note: The webhook request body must be prepared depending upon environment(Staging or Prod) as shown in the previous step)

1. Topic: “Orders.Created“

2. Topic: “Orders.Cancelled”

3. Topic: “Orders.Delivered”

4. Topic: “Orders.Updated”

• Model: CreateEventsSubscriptionRequest

• Method: eventsSubscription

create an event subscription request by passing the above prepared EventSubscription request body one by one for each Topic using method(eventsSubscription). This method will return an Object of CreateEventsSubscriptionRequest.

• Model: CreateEventsSubscriptionResult

• Method: createEventsSubscription

Pass the Object of CreateEventsSubscriptionRequest in the method(createEventsSubscription) to register the the webhook’s