@guayaba/workflow-piece-webhook 0.1.33

package/src/i18n/sv.json

@@ -0,0 +1,28 @@
+{
+  "Webhook": "Webhook",
+  "Receive HTTP requests and trigger flows using unique URLs.": "Receive HTTP requests and trigger flows using unique URLs.",
+  "Return Response": "Return Response",
+  "Respond and Wait for Next Webhook": "Respond and Wait for Next Webhook",
+  "return a response": "return a response",
+  "return a response and wait for the next webhook to resume the flow": "return a response and wait for the next webhook to resume the flow",
+  "Response Type": "Response Type",
+  "Response": "Response",
+  "Flow Execution": "Flow Execution",
+  "Markdown": "Markdown",
+  "**Respond and Wait for Next Webhook**<br> \n            Check the response header (x-activepieces-resume-webhook-url) for the next webhook URL and call it to resume the flow. <br>\n            ": "**Respond and Wait for Next Webhook**<br> \n            Check the response header (x-activepieces-resume-webhook-url) for the next webhook URL and call it to resume the flow. <br>\n            ",
+  "JSON": "JSON",
+  "Raw": "Raw",
+  "Redirect": "Redirect",
+  "Stop": "Stop",
+  "Respond and Continue": "Respond and Continue",
+  "Catch Webhook": "Catch Webhook",
+  "Receive incoming HTTP/webhooks using any HTTP method such as GET, POST, PUT, DELETE, etc.": "Receive incoming HTTP/webhooks using any HTTP method such as GET, POST, PUT, DELETE, etc.",
+  "Authentication": "Authentication",
+  "Authentication Fields": "Authentication Fields",
+  "**Live URL:**\n```text\n{{webhookUrl}}\n```\ngenerate sample data & triggers published flow.\n\n": "**Live URL:**\n```text\n{{webhookUrl}}\n```\ngenerate sample data & triggers published flow.\n\n",
+  "**Synchronous Requests:**\n\nIf you expect a response from this webhook, add `/sync` to the end of the URL. \nIf it takes more than 30 seconds, it will return a 408 Request Timeout response.\n\nTo return data, add an Webhook step to your flow with the Return Response action.\n": "**Synchronous Requests:**\n\nIf you expect a response from this webhook, add `/sync` to the end of the URL. \nIf it takes more than 30 seconds, it will return a 408 Request Timeout response.\n\nTo return data, add an Webhook step to your flow with the Return Response action.\n",
+  "\n**Test URL:**\n\nif you want to generate sample data without triggering the flow, append `/test` to your webhook URL.\n\n": "\n**Test URL:**\n\nif you want to generate sample data without triggering the flow, append `/test` to your webhook URL.\n\n",
+  "None": "None",
+  "Basic Auth": "Basic Auth",
+  "Header Auth": "Header Auth"
+}

package/src/i18n/translation.json

@@ -0,0 +1,27 @@
+{
+  "Receive HTTP requests and trigger flows using unique URLs.": "Receive HTTP requests and trigger flows using unique URLs.",
+  "Return Response": "Return Response",
+  "Respond and Wait for Next Webhook": "Respond and Wait for Next Webhook",
+  "return a response": "return a response",
+  "return a response and wait for the next webhook to resume the flow": "return a response and wait for the next webhook to resume the flow",
+  "Response Type": "Response Type",
+  "Response": "Response",
+  "Flow Execution": "Flow Execution",
+  "Markdown": "Markdown",
+  "**Respond and Wait for Next Webhook**<br> \n            Check the response header (x-activepieces-resume-webhook-url) for the next webhook URL and call it to resume the flow. <br>\n            ": "**Respond and Wait for Next Webhook**<br> \n            Check the response header (x-activepieces-resume-webhook-url) for the next webhook URL and call it to resume the flow. <br>\n            ",
+  "JSON": "JSON",
+  "Raw": "Raw",
+  "Redirect": "Redirect",
+  "Stop": "Stop",
+  "Respond and Continue": "Respond and Continue",
+  "Catch Webhook": "Catch Webhook",
+  "Receive incoming HTTP/webhooks using any HTTP method such as GET, POST, PUT, DELETE, etc.": "Receive incoming HTTP/webhooks using any HTTP method such as GET, POST, PUT, DELETE, etc.",
+  "Authentication": "Authentication",
+  "Authentication Fields": "Authentication Fields",
+  "**Live URL:**\n```text\n{{webhookUrl}}\n```\ngenerate sample data & triggers published flow.\n\n": "**Live URL:**\n```text\n{{webhookUrl}}\n```\ngenerate sample data & triggers published flow.\n\n",
+  "**Synchronous Requests:**\n\nIf you expect a response from this webhook, add `/sync` to the end of the URL. \nIf it takes more than 30 seconds, it will return a 408 Request Timeout response.\n\nTo return data, add an Webhook step to your flow with the Return Response action.\n": "**Synchronous Requests:**\n\nIf you expect a response from this webhook, add `/sync` to the end of the URL. \nIf it takes more than 30 seconds, it will return a 408 Request Timeout response.\n\nTo return data, add an Webhook step to your flow with the Return Response action.\n",
+  "\n**Test URL:**\n\nif you want to generate sample data without triggering the flow, append `/test` to your webhook URL.\n\n": "\n**Test URL:**\n\nif you want to generate sample data without triggering the flow, append `/test` to your webhook URL.\n\n",
+  "None": "None",
+  "Basic Auth": "Basic Auth",
+  "Header Auth": "Header Auth"
+}

package/src/i18n/uk.json

@@ -0,0 +1,28 @@
+{
+  "Webhook": "Webhook",
+  "Receive HTTP requests and trigger flows using unique URLs.": "Receive HTTP requests and trigger flows using unique URLs.",
+  "Return Response": "Return Response",
+  "Respond and Wait for Next Webhook": "Respond and Wait for Next Webhook",
+  "return a response": "return a response",
+  "return a response and wait for the next webhook to resume the flow": "return a response and wait for the next webhook to resume the flow",
+  "Response Type": "Response Type",
+  "Response": "Response",
+  "Flow Execution": "Flow Execution",
+  "Markdown": "Markdown",
+  "**Respond and Wait for Next Webhook**<br> \n            Check the response header (x-activepieces-resume-webhook-url) for the next webhook URL and call it to resume the flow. <br>\n            ": "**Respond and Wait for Next Webhook**<br> \n            Check the response header (x-activepieces-resume-webhook-url) for the next webhook URL and call it to resume the flow. <br>\n            ",
+  "JSON": "JSON",
+  "Raw": "Raw",
+  "Redirect": "Redirect",
+  "Stop": "Stop",
+  "Respond and Continue": "Respond and Continue",
+  "Catch Webhook": "Catch Webhook",
+  "Receive incoming HTTP/webhooks using any HTTP method such as GET, POST, PUT, DELETE, etc.": "Receive incoming HTTP/webhooks using any HTTP method such as GET, POST, PUT, DELETE, etc.",
+  "Authentication": "Authentication",
+  "Authentication Fields": "Authentication Fields",
+  "**Live URL:**\n```text\n{{webhookUrl}}\n```\ngenerate sample data & triggers published flow.\n\n": "**Live URL:**\n```text\n{{webhookUrl}}\n```\ngenerate sample data & triggers published flow.\n\n",
+  "**Synchronous Requests:**\n\nIf you expect a response from this webhook, add `/sync` to the end of the URL. \nIf it takes more than 30 seconds, it will return a 408 Request Timeout response.\n\nTo return data, add an Webhook step to your flow with the Return Response action.\n": "**Synchronous Requests:**\n\nIf you expect a response from this webhook, add `/sync` to the end of the URL. \nIf it takes more than 30 seconds, it will return a 408 Request Timeout response.\n\nTo return data, add an Webhook step to your flow with the Return Response action.\n",
+  "\n**Test URL:**\n\nif you want to generate sample data without triggering the flow, append `/test` to your webhook URL.\n\n": "\n**Test URL:**\n\nif you want to generate sample data without triggering the flow, append `/test` to your webhook URL.\n\n",
+  "None": "None",
+  "Basic Auth": "Basic Auth",
+  "Header Auth": "Header Auth"
+}

package/src/i18n/vi.json

@@ -0,0 +1,28 @@
+{
+  "Webhook": "Webhook",
+  "Receive HTTP requests and trigger flows using unique URLs.": "Receive HTTP requests and trigger flows using unique URLs.",
+  "Return Response": "Return Response",
+  "Respond and Wait for Next Webhook": "Respond and Wait for Next Webhook",
+  "return a response": "return a response",
+  "return a response and wait for the next webhook to resume the flow": "return a response and wait for the next webhook to resume the flow",
+  "Response Type": "Response Type",
+  "Response": "Response",
+  "Flow Execution": "Flow Execution",
+  "Markdown": "Markdown",
+  "**Respond and Wait for Next Webhook**<br> \n            Check the response header (x-activepieces-resume-webhook-url) for the next webhook URL and call it to resume the flow. <br>\n            ": "**Respond and Wait for Next Webhook**<br> \n            Check the response header (x-activepieces-resume-webhook-url) for the next webhook URL and call it to resume the flow. <br>\n            ",
+  "JSON": "JSON",
+  "Raw": "Raw",
+  "Redirect": "Redirect",
+  "Stop": "Stop",
+  "Respond and Continue": "Respond and Continue",
+  "Catch Webhook": "Catch Webhook",
+  "Receive incoming HTTP/webhooks using any HTTP method such as GET, POST, PUT, DELETE, etc.": "Receive incoming HTTP/webhooks using any HTTP method such as GET, POST, PUT, DELETE, etc.",
+  "Authentication": "Authentication",
+  "Authentication Fields": "Authentication Fields",
+  "**Live URL:**\n```text\n{{webhookUrl}}\n```\ngenerate sample data & triggers published flow.\n\n": "**Live URL:**\n```text\n{{webhookUrl}}\n```\ngenerate sample data & triggers published flow.\n\n",
+  "**Synchronous Requests:**\n\nIf you expect a response from this webhook, add `/sync` to the end of the URL. \nIf it takes more than 30 seconds, it will return a 408 Request Timeout response.\n\nTo return data, add an Webhook step to your flow with the Return Response action.\n": "**Synchronous Requests:**\n\nIf you expect a response from this webhook, add `/sync` to the end of the URL. \nIf it takes more than 30 seconds, it will return a 408 Request Timeout response.\n\nTo return data, add an Webhook step to your flow with the Return Response action.\n",
+  "\n**Test URL:**\n\nif you want to generate sample data without triggering the flow, append `/test` to your webhook URL.\n\n": "\n**Test URL:**\n\nif you want to generate sample data without triggering the flow, append `/test` to your webhook URL.\n\n",
+  "None": "None",
+  "Basic Auth": "Basic Auth",
+  "Header Auth": "Header Auth"
+}

package/src/i18n/zh.json

@@ -0,0 +1,27 @@
+{
+  "Receive HTTP requests and trigger flows using unique URLs.": "使用唯一的 URL 接收HTTP 请求和触发流。",
+  "Return Response": "退货回复",
+  "Respond and Wait for Next Webhook": "响应并等待下一个 Webhook",
+  "return a response": "返回响应",
+  "return a response and wait for the next webhook to resume the flow": "返回响应并等待下一个 web 钩子以恢复流",
+  "Response Type": "响应类型",
+  "Response": "答复",
+  "Flow Execution": "流执行",
+  "Markdown": "Markdown",
+  "**Respond and Wait for Next Webhook**<br> \n            Check the response header (x-activepieces-resume-webhook-url) for the next webhook URL and call it to resume the flow. <br>\n            ": "**响应并等待下一个 Webhook**<br> \n            请检查下一个 webhook URL 的响应头(x-activethes-resume-webhook-url) 并调用它来恢复流程。 <br>\n            ",
+  "JSON": "JSON",
+  "Raw": "原始文件",
+  "Redirect": "重定向",
+  "Stop": "停止",
+  "Respond and Continue": "响应并继续",
+  "Catch Webhook": "捕获Webhook",
+  "Receive incoming HTTP/webhooks using any HTTP method such as GET, POST, PUT, DELETE, etc.": "使用 GET、POST、PUT、DELETE等任何HTTP 方法接收传入的 HTTP/webhooks 。",
+  "Authentication": "认证",
+  "Authentication Fields": "身份验证字段",
+  "**Live URL:**\n```text\n{{webhookUrl}}\n```\ngenerate sample data & triggers published flow.\n\n": "**Live URL:**\n```text\n{{webhookUrl}}\n```\ngenerate sample data & triggers published flow.\n\n",
+  "**Synchronous Requests:**\n\nIf you expect a response from this webhook, add `/sync` to the end of the URL. \nIf it takes more than 30 seconds, it will return a 408 Request Timeout response.\n\nTo return data, add an Webhook step to your flow with the Return Response action.\n": "**Synchronous Requests:**\n\nIf you expect a response from this webhook, add `/sync` to the end of the URL. \nIf it takes more than 30 seconds, it will return a 408 Request Timeout response.\n\nTo return data, add an Webhook step to your flow with the Return Response action.\n",
+  "\n**Test URL:**\n\nif you want to generate sample data without triggering the flow, append `/test` to your webhook URL.\n\n": "\n**Test URL:**\n\nif you want to generate sample data without triggering the flow, append `/test` to your webhook URL.\n\n",
+  "None": "无",
+  "Basic Auth": "基本认证",
+  "Header Auth": "头部认证"
+}

package/src/index.ts

@@ -0,0 +1,17 @@
+import { createPiece, PieceAuth } from '@guayaba/workflows-framework';
+import { catchWebhook } from './lib/triggers/catch-hook';
+import { PieceCategory } from '@guayaba/workflows-shared';
+import { returnResponse } from './lib/actions/return-response';
+import { returnResponseAndWaitForNextWebhook } from './lib/actions/return-response-and-wait-for-next-webhook';
+
+export const webhook = createPiece({
+  displayName: 'Webhook',
+  description: 'Receive HTTP requests and trigger flows using unique URLs.',
+  auth: PieceAuth.None(),
+  categories: [PieceCategory.CORE],
+  minimumSupportedRelease: '0.82.0',
+  logoUrl: 'https://cdn.activepieces.com/pieces/new-core/webhooks.svg',
+  authors: ['abuaboud', 'pfernandez98', 'kishanprmr','AbdulTheActivePiecer'],
+  actions: [returnResponse,returnResponseAndWaitForNextWebhook],
+  triggers: [catchWebhook],
+});

package/src/lib/actions/return-response-and-wait-for-next-webhook.ts

@@ -0,0 +1,163 @@
+import {
+    DynamicPropsValue,
+    PieceAuth,
+    Property,
+    createAction,
+  } from '@guayaba/workflows-framework';
+  import { ExecutionType, StopResponse } from '@guayaba/workflows-shared';
+  import { StatusCodes } from 'http-status-codes';
+  
+  enum ResponseType {
+    JSON = 'json',
+    RAW = 'raw',
+    REDIRECT = 'redirect',
+  }
+  
+
+  const RESUME_WEBHOOK_HEADER = 'x-activepieces-resume-webhook-url';
+  export const returnResponseAndWaitForNextWebhook = createAction({
+    name: 'return_response_and_wait_for_next_webhook',
+    displayName: 'Respond and Wait for Next Webhook',
+    description: 'return a response and wait for the next webhook to resume the flow',
+    props: {
+        markdown: Property.MarkDown({
+            value: `**Respond and Wait for Next Webhook**<br> 
+            Check the response header (${RESUME_WEBHOOK_HEADER}) for the next webhook URL and call it to resume the flow. <br>
+            `,
+          }),  
+      responseType: Property.StaticDropdown({
+        displayName: 'Response Type',
+        required: false,
+        defaultValue: 'json',
+        options: {
+          disabled: false,
+          options: [
+            {
+              label: 'JSON',
+              value: ResponseType.JSON,
+            },
+            {
+              label: 'Raw',
+              value: ResponseType.RAW,
+            },
+            {
+              label: 'Redirect',
+              value: ResponseType.REDIRECT,
+            },
+          ],
+        },
+      }),
+      fields: Property.DynamicProperties({
+        auth: PieceAuth.None(),
+        displayName: 'Response',
+        refreshers: ['responseType'],
+        required: true,
+        props: async ({ responseType }) => {
+          if (!responseType) return {};
+  
+          const bodyTypeInput = responseType as unknown as ResponseType;
+  
+          const fields: DynamicPropsValue = {};
+  
+          if (bodyTypeInput !== ResponseType.REDIRECT) {
+            fields['status'] = Property.Number({
+              displayName: 'Status',
+              required: false,
+              defaultValue: 200,
+            });
+            fields['headers'] = Property.Object({
+              displayName: 'Headers',
+              required: false,
+            });
+          }
+  
+          switch (bodyTypeInput) {
+            case ResponseType.JSON:
+              fields['body'] = Property.Json({
+                displayName: 'JSON Body',
+                required: true,
+              });
+              break;
+            case ResponseType.RAW:
+              fields['body'] = Property.LongText({
+                displayName: 'Raw Body',
+                required: true,
+              });
+              break;
+            case ResponseType.REDIRECT:
+              fields['body'] = Property.LongText({
+                displayName: 'Redirect URL',
+                required: true,
+              });
+              break;
+          }
+          return fields;
+        },
+      }),
+    },
+  
+    async run(context) {
+      const { fields, responseType } = context.propsValue;
+      const bodyInput = fields ['body'];
+      const headers = fields['headers'] ?? {};
+      const status = fields['status'];
+      const response: StopResponse = {
+        status: status ?? StatusCodes.OK,
+        headers,
+      };
+
+      switch (responseType) {
+        case ResponseType.JSON:
+          response.body = praseToJson(bodyInput);
+          break;
+        case ResponseType.RAW:
+          response.body = bodyInput;
+          break;
+        case ResponseType.REDIRECT:
+          response.status = StatusCodes.MOVED_PERMANENTLY;
+          response.headers = { ...response.headers, Location: ensureProtocol(bodyInput) };
+          response.body = bodyInput;
+          break;
+      }
+
+      if(context.executionType === ExecutionType.BEGIN){
+        const waitpoint = await context.run.createWaitpoint({
+          type: 'WEBHOOK',
+          responseToSend: response,
+        });
+        headers[RESUME_WEBHOOK_HEADER] = waitpoint.buildResumeUrl({
+          queryParams: {
+            created: new Date().toISOString(),
+            runId: context.run.id,
+          },
+          sync: true,
+        });
+        context.run.waitForWaitpoint(waitpoint.id);
+        return {
+          nextWebhookUrl: headers[RESUME_WEBHOOK_HEADER],
+        };
+      }
+      else {
+        return {
+          body: context.resumePayload.body,
+          headers: context.resumePayload.headers,
+          queryParams: context.resumePayload.queryParams,
+        }
+      }
+    },
+  });
+  
+  function praseToJson(body: unknown) {
+    if (typeof body === 'string') {
+      return JSON.parse(body);
+    }
+    return JSON.parse(JSON.stringify(body));
+  }
+  
+  function ensureProtocol(url: string): string {
+    if (!url.startsWith('http://') && !url.startsWith('https://')) {
+      return `https://${url}`;
+    }
+    return url;
+  }
+  

package/src/lib/actions/return-response.ts

@@ -0,0 +1,171 @@
+import {
+  DynamicPropsValue,
+  PieceAuth,
+  Property,
+  createAction,
+} from '@guayaba/workflows-framework';
+import { StopResponse } from '@guayaba/workflows-shared';
+import { StatusCodes } from 'http-status-codes';
+
+enum ResponseType {
+  JSON = 'json',
+  RAW = 'raw',
+  REDIRECT = 'redirect',
+}
+
+enum FlowExecution {
+  STOP = 'stop',
+  RESPOND = 'respond',
+}
+
+export const returnResponse = createAction({
+  name: 'return_response',
+  displayName: 'Return Response',
+  description: 'return a response',
+  props: {
+    responseType: Property.StaticDropdown({
+      displayName: 'Response Type',
+      required: false,
+      defaultValue: 'json',
+      options: {
+        disabled: false,
+        options: [
+          {
+            label: 'JSON',
+            value: ResponseType.JSON,
+          },
+          {
+            label: 'Raw',
+            value: ResponseType.RAW,
+          },
+          {
+            label: 'Redirect',
+            value: ResponseType.REDIRECT,
+          },
+        ],
+      },
+    }),
+    fields: Property.DynamicProperties({
+      auth: PieceAuth.None(),
+      displayName: 'Response',
+      refreshers: ['responseType'],
+      required: true,
+      props: async ({ responseType }) => {
+        if (!responseType) return {};
+
+        const bodyTypeInput = responseType as unknown as ResponseType;
+
+        const fields: DynamicPropsValue = {};
+
+        if (bodyTypeInput !== ResponseType.REDIRECT) {
+          fields['status'] = Property.Number({
+            displayName: 'Status',
+            required: false,
+            defaultValue: 200,
+          });
+          fields['headers'] = Property.Object({
+            displayName: 'Headers',
+            required: false,
+          });
+        }
+
+        switch (bodyTypeInput) {
+          case ResponseType.JSON:
+            fields['body'] = Property.Json({
+              displayName: 'JSON Body',
+              required: true,
+            });
+            break;
+          case ResponseType.RAW:
+            fields['body'] = Property.LongText({
+              displayName: 'Raw Body',
+              required: true,
+            });
+            break;
+          case ResponseType.REDIRECT:
+            fields['body'] = Property.LongText({
+              displayName: 'Redirect URL',
+              required: true,
+            });
+            break;
+        }
+        return fields;
+      },
+    }),
+    respond: Property.StaticDropdown({
+      displayName: 'Flow Execution',
+      required: false,
+      defaultValue: FlowExecution.STOP,
+      options: {
+        disabled: false,
+        options: [
+          { label: 'Stop', value: FlowExecution.STOP },
+          { label: 'Respond and Continue', value: FlowExecution.RESPOND },
+        ],
+      },
+    }),
+  },
+
+  async run(context) {
+    const { fields, responseType, respond } = context.propsValue;
+    const bodyInput = fields ['body'];
+    const headers = fields['headers']?? {};
+    const status = fields['status'];
+    
+ 
+    const response: StopResponse = {
+      status: status ?? StatusCodes.OK,
+      headers,
+    };
+
+    switch (responseType) {
+      case ResponseType.JSON:
+        response.body = praseToJson(bodyInput);
+        break;
+      case ResponseType.RAW:
+        response.body = bodyInput;
+        break;
+      case ResponseType.REDIRECT:
+        response.status = StatusCodes.MOVED_PERMANENTLY;
+        response.headers = { ...response.headers, Location: ensureProtocol(bodyInput) };
+        response.body = bodyInput;
+        break;
+    }
+    
+    switch(respond){
+      case FlowExecution.STOP:
+        {
+          context.run.stop({
+            response,
+          });
+          break;
+        }
+      case FlowExecution.RESPOND:
+        {
+          context.run.respond({
+            response,
+          });
+          break;
+        }
+        case undefined:
+          break;
+    }
+ 
+
+    return response;
+  },
+});
+
+function praseToJson(body: unknown) {
+  if (typeof body === 'string') {
+    return JSON.parse(body);
+  }
+  return JSON.parse(JSON.stringify(body));
+}
+
+function ensureProtocol(url: string): string {
+  if (!url.startsWith('http://') && !url.startsWith('https://')) {
+    return `https://${url}`;
+  }
+  return url;
+}