Gorgias Update Sources to Webhooks

components/gorgias/gorgias.app.mjs

@@ -153,6 +153,35 @@ export default {
         cursor = meta.next_cursor;
       } while (cursor);
     },
+    async createWebhook({
+      url,
+      eventType,
+    }) {
+      return this._makeRequest({
+        path: "integrations",
+        method: "post",
+        data: {
+          name: `pipedream-${url}`,
+          type: "http",
+          http: {
+            url,
+            method: "POST",
+            request_content_type: "application/json",
+            response_content_type: "application/json",
+            form: "{{context}}",
+            triggers: {
+              [eventType]: true,
+            },
+          },
+        },
+      });
+    },
+    async deleteWebhook({ id }) {
+      return this._makeRequest({
+        path: `integrations/${id}`,
+        method: "delete",
+      });
+    },
     async getEvents({
       $, params,
     }) {
@@ -218,5 +247,13 @@ export default {
         params,
       });
     },
+    async retrieveTicket({
+      $, id,
+    }) {
+      return this._makeRequest({
+        $,
+        path: `tickets/${id}`,
+      });
+    },
   },
 };

components/gorgias/sources/common/base.mjs

@@ -5,49 +5,82 @@ export default {
   props: {
     gorgias,
     db: "$.service.db",
-    timer: {
-      type: "$.interface.timer",
-      default: {
-        intervalSeconds: 15 * 60,
-      },
+    http: "$.interface.http",
+  },
+  hooks: {
+    async deploy() {
+      console.log("Retrieving historical events...");
+      const events = this.gorgias.paginate({
+        fn: this.gorgias.getEvents,
+        params: {
+          types: this.getEventType(),
+        },
+      });
+      for await (const event of events) {
+        await this.processHistoricalEvent(event);
+      }
+    },
+    async activate() {
+      console.log("Creating webhook...");
+      const { id } = await this.gorgias.createWebhook({
+        url: this.http.endpoint,
+        eventType: this.getEventType(),
+      });
+      this.setWebhookId(id);
+      console.log(`Webhook ${id} created successfully`);
+    },
+    async deactivate() {
+      const id = this.getWebhookId();
+      console.log(`Deleting webhook ${id}...`);
+      await this.gorgias.deleteWebhook({
+        id,
+      });
+      this.setWebhookId();
+      console.log(`Webhook ${id} deleted successfully`);
     },
   },
   methods: {
-    getNextCursor() {
-      return this.db.get("nextCursor");
+    getTimestampKey() {
+      return this.getEventType().includes("updated")
+        ? "updated_datetime"
+        : "created_datetime";
     },
-    setNextCursor(nextCursor) {
-      if (nextCursor) {
-        this.db.set("nextCursor", nextCursor);
-      }
+    getEventType() {
+      throw new Error("getEventType is not implemented");
     },
-    getEventTypes() {
-      throw new Error("getEventTypes is not implemented");
+    processEvent() {
+      throw new Error("processEvent is not implemented");
     },
-    async emitEvents(events) {
-      for (const event of events) {
-        this.$emit(event, {
-          id: event.id,
-          ts: Date.parse(event.created_datetime),
-          summary: `New ${event.type} event: ${event.id}`,
-        });
-      }
+    processHistoricalEvent() {
+      throw new Error("processHistoricalEvent is not implemented");
+    },
+    getWebhookId() {
+      return this.db.get("webhookId");
+    },
+    setWebhookId(webhookId) {
+      this.db.set("webhookId", webhookId);
+    },
+    async retrieveTicket(id) {
+      console.log(`Received ${this.getEventType()} for ticket ${id}`);
+      console.log(`Fetching data for ticket ${id}`);
+      return this.gorgias.retrieveTicket({
+        id,
+      });
+    },
+    emitEvent(event) {
+      console.log(`Emitting event ${event.id}:`);
+      console.log(event);
+      const ts = Date.parse(event[this.getTimestampKey()]);
+      this.$emit(event, {
+        id: `${event.id}_${ts}`,
+        ts,
+        summary: `New ${this.getEventType()}: ${event.id}`,
+      });
     },
   },
-  async run() {
-    const params = {
-      cursor: this.getNextCursor(),
-      ...this.getEventTypes(),
-    };
-
-    const {
-      data: events,
-      meta,
-    } = await this.gorgias.getEvents({
-      params,
-    });
-
-    this.emitEvents(events);
-    this.setNextCursor(meta.next_cursor);
+  async run(event) {
+    console.log("Raw received event:");
+    console.log(event);
+    return this.processEvent(event.body);
   },
 };

components/gorgias/sources/ticket-created/ticket-created.mjs

@@ -6,14 +6,19 @@ export default {
   key: "gorgias-ticket-created",
   name: "New Ticket",
   description: "Emit new event when a ticket is created. [See the docs](https://developers.gorgias.com/reference/the-event-object)",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "source",
   methods: {
     ...base.methods,
-    getEventTypes() {
-      return {
-        types: eventTypes.TICKET_CREATED,
-      };
+    getEventType() {
+      return eventTypes.TICKET_CREATED;
+    },
+    async processHistoricalEvent(event) {
+      const ticket = await this.retrieveTicket(event.object_id);
+      this.emitEvent(ticket);
+    },
+    async processEvent(event) {
+      this.emitEvent(event.ticket);
     },
   },
 };

components/gorgias/sources/ticket-message-created/ticket-message-created.mjs

@@ -6,14 +6,19 @@ export default {
   key: "gorgias-ticket-messaged-created",
   name: "New Ticket Message",
   description: "Emit new event when a ticket message is created. [See the docs](https://developers.gorgias.com/reference/the-event-object)",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "source",
   methods: {
     ...base.methods,
-    getEventTypes() {
-      return {
-        types: eventTypes.TICKET_MESSAGE_CREATED,
-      };
+    getEventType() {
+      return eventTypes.TICKET_MESSAGE_CREATED;
+    },
+    async processHistoricalEvent(event) {
+      // event doesn't contain ticket id to fetch message
+      this.emitEvent(event);
+    },
+    async processEvent(event) {
+      this.emitEvent(event.message);
     },
   },
 };

components/gorgias/sources/ticket-updated/ticket-updated.mjs

@@ -6,14 +6,19 @@ export default {
   key: "gorgias-ticket-updated",
   name: "New Updated Ticket",
   description: "Emit new event when a ticket is updated. [See the docs](https://developers.gorgias.com/reference/the-event-object)",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "source",
   methods: {
     ...base.methods,
-    getEventTypes() {
-      return {
-        types: eventTypes.TICKET_UPDATED,
-      };
+    getEventType() {
+      return eventTypes.TICKET_UPDATED;
+    },
+    async processHistoricalEvent(event) {
+      const ticket = await this.retrieveTicket(event.object_id);
+      this.emitEvent(ticket);
+    },
+    async processEvent(event) {
+      this.emitEvent(event.ticket);
     },
   },
 };

components/gorgias_oauth/actions/create-customer/create-customer.mjs

@@ -3,11 +3,12 @@ import overrideApp from "../../common/override-app.mjs";
 
 overrideApp(base);
 
+// same version as base
+// eslint-disable-next-line pipedream/required-properties-version
 export default {
   ...base,
   key: "gorgias_oauth-create-customer",
   name: "Create Customer",
   description: "Create a new customer. [See the docs](https://developers.gorgias.com/reference/post_api-customers)",
-  version: "0.0.1",
   type: "action",
 };

components/gorgias_oauth/actions/create-ticket/create-ticket.mjs

@@ -3,11 +3,12 @@ import overrideApp from "../../common/override-app.mjs";
 
 overrideApp(base);
 
+// same version as base
+// eslint-disable-next-line pipedream/required-properties-version
 export default {
   ...base,
   key: "gorgias_oauth-create-ticket",
   name: "Create Ticket",
   description: "Create a new ticket. [See the docs](https://developers.gorgias.com/reference/post_api-tickets)",
-  version: "0.0.1",
   type: "action",
 };

components/gorgias_oauth/actions/list-tickets/list-tickets.mjs

@@ -3,11 +3,12 @@ import overrideApp from "../../common/override-app.mjs";
 
 overrideApp(base);
 
+// same version as base
+// eslint-disable-next-line pipedream/required-properties-version
 export default {
   ...base,
   key: "gorgias_oauth-list-tickets",
   name: "List Tickets",
   description: "List all tickets. [See the docs](https://developers.gorgias.com/reference/get_api-tickets)",
-  version: "0.0.1",
   type: "action",
 };

components/gorgias_oauth/actions/retrieve-customer/retrieve-customer.mjs

@@ -3,11 +3,12 @@ import overrideApp from "../../common/override-app.mjs";
 
 overrideApp(base);
 
+// same version as base
+// eslint-disable-next-line pipedream/required-properties-version
 export default {
   ...base,
   key: "gorgias_oauth-retrieve-customer",
   name: "Retrieve a Customer",
   description: "Retrieve a customer. [See the docs](https://developers.gorgias.com/reference/get_api-customers-id-)",
-  version: "0.0.1",
   type: "action",
 };

components/gorgias_oauth/actions/update-customer/update-customer.mjs

@@ -3,11 +3,12 @@ import overrideApp from "../../common/override-app.mjs";
 
 overrideApp(base);
 
+// same version as base
+// eslint-disable-next-line pipedream/required-properties-version
 export default {
   ...base,
   key: "gorgias_oauth-update-customer",
   name: "Update Customer",
   description: "Update a customer. [See the docs](https://developers.gorgias.com/reference/put_api-customers-id-)",
-  version: "0.0.1",
   type: "action",
 };

components/gorgias_oauth/sources/ticket-created/ticket-created.mjs

@@ -3,11 +3,12 @@ import overrideApp from "../../common/override-app.mjs";
 
 overrideApp(base);
 
+// same version as base
+// eslint-disable-next-line pipedream/required-properties-version
 export default {
   ...base,
   key: "gorgias_oauth-ticket-created",
   name: "New Ticket",
   description: "Emit new event when a ticket is created. [See the docs](https://developers.gorgias.com/reference/the-event-object)",
-  version: "0.0.1",
   type: "source",
 };

components/gorgias_oauth/sources/ticket-message-created/ticket-message-created.mjs

@@ -3,11 +3,12 @@ import overrideApp from "../../common/override-app.mjs";
 
 overrideApp(base);
 
+// same version as base
+// eslint-disable-next-line pipedream/required-properties-version
 export default {
   ...base,
   key: "gorgias_oauth-ticket-messaged-created",
   name: "New Ticket Message",
   description: "Emit new event when a ticket message is created. [See the docs](https://developers.gorgias.com/reference/the-event-object)",
-  version: "0.0.1",
   type: "source",
 };

components/gorgias_oauth/sources/ticket-updated/ticket-updated.mjs

@@ -3,11 +3,12 @@ import overrideApp from "../../common/override-app.mjs";
 
 overrideApp(base);
 
+// same version as base
+// eslint-disable-next-line pipedream/required-properties-version
 export default {
   ...base,
   key: "gorgias_oauth-ticket-updated",
   name: "New Updated Ticket",
   description: "Emit new event when a ticket is updated. [See the docs](https://developers.gorgias.com/reference/the-event-object)",
-  version: "0.0.1",
   type: "source",
 };