Add front signalwire integration, use new integration list format

webhookdb · Feb 28, 2024 · bb11d22 · bb11d22
1 parent 12ce28c
commit bb11d22
Show file tree

Hide file tree

Showing 84 changed files with 710 additions and 139 deletions.
diff --git a/_includes/enterprise_integration_list.md b/_includes/enterprise_integration_list.md
@@ -0,0 +1,2 @@
+{: .enterprise  }
+<i class="fa-solid fa-crown text-yellow-100"></i> This integration is included in [WebhookDB Enterprise]({% link docs/enterprise.md %}).
diff --git a/_includes/replicator_list.md b/_includes/replicator_list.md
@@ -17,6 +17,7 @@
 - [Front Conversation]({% link _integrations/front_conversation_v1.md %})
 - [Front Auth]({% link _integrations/front_marketplace_root_v1.md %})
 - [Front Message]({% link _integrations/front_message_v1.md %})
+- [Front/SignalWire Message]({% link _integrations/front_signalwire_message_channel_app_v1.md %})
 - [GitHub Issue Comment]({% link _integrations/github_issue_comment_v1.md %})
 - [GitHub Issue]({% link _integrations/github_issue_v1.md %})
 - [GitHub Pull Request]({% link _integrations/github_pull_v1.md %})

diff --git a/_integrations/atom_single_feed_v1.md b/_integrations/atom_single_feed_v1.md
@@ -8,7 +8,12 @@ nav_order: 10
 
 Convert any Atom XML feed into a database table for querying and persistent archiving.
 
-Docs for this API: [https://en.wikipedia.org/wiki/Atom_(web_standard)](https://en.wikipedia.org/wiki/Atom_(web_standard))
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create atom_single_feed_v1
+```
+
+Source documentation for this API: [https://en.wikipedia.org/wiki/Atom_(web_standard)](https://en.wikipedia.org/wiki/Atom_(web_standard))
 
 ## Features
 

diff --git a/_integrations/aws_pricing_v1.md b/_integrations/aws_pricing_v1.md
@@ -8,7 +8,12 @@ nav_order: 20
 
 Fetch, parse, and process AWS price list information from the API into a relational, fully searchable table.
 
-Docs for this API: [https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-list-query-api-find-services-products.html](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-list-query-api-find-services-products.html)
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create aws_pricing_v1
+```
+
+Source documentation for this API: [https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-list-query-api-find-services-products.html](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-list-query-api-find-services-products.html)
 
 ## Features
 

diff --git a/_integrations/bookingpal_listing_calendar_v1.md b/_integrations/bookingpal_listing_calendar_v1.md
@@ -6,9 +6,17 @@ nav_order: 30
 
 # BookingPal Listing Calendar (`bookingpal_listing_calendar_v1`)
 
+{% include enterprise_integration_list.md %}
+
+
 Replicate BookingPal Listing Calendars into your database.
 
-Docs for this API: [https://www.apimatic.io/apidocs/channelapi/v/2_24](https://www.apimatic.io/apidocs/channelapi/v/2_24)
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create bookingpal_listing_calendar_v1
+```
+
+Source documentation for this API: [https://www.apimatic.io/apidocs/channelapi/v/2_24](https://www.apimatic.io/apidocs/channelapi/v/2_24)
 
 ## Features
 

diff --git a/_integrations/bookingpal_listing_photo_v1.md b/_integrations/bookingpal_listing_photo_v1.md
@@ -6,9 +6,17 @@ nav_order: 40
 
 # BookingPal Listing Photo (`bookingpal_listing_photo_v1`)
 
+{% include enterprise_integration_list.md %}
+
+
 Replicate BookingPal Listing Photos into your database.
 
-Docs for this API: [https://www.apimatic.io/apidocs/channelapi/v/2_24](https://www.apimatic.io/apidocs/channelapi/v/2_24)
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create bookingpal_listing_photo_v1
+```
+
+Source documentation for this API: [https://www.apimatic.io/apidocs/channelapi/v/2_24](https://www.apimatic.io/apidocs/channelapi/v/2_24)
 
 ## Features
 

diff --git a/_integrations/bookingpal_listing_policy_v1.md b/_integrations/bookingpal_listing_policy_v1.md
@@ -6,9 +6,17 @@ nav_order: 50
 
 # BookingPal Listing Policy (`bookingpal_listing_policy_v1`)
 
+{% include enterprise_integration_list.md %}
+
+
 Replicate BookingPal Listing Policies into your database.
 
-Docs for this API: [https://www.apimatic.io/apidocs/channelapi/v/2_24](https://www.apimatic.io/apidocs/channelapi/v/2_24)
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create bookingpal_listing_policy_v1
+```
+
+Source documentation for this API: [https://www.apimatic.io/apidocs/channelapi/v/2_24](https://www.apimatic.io/apidocs/channelapi/v/2_24)
 
 ## Features
 

diff --git a/_integrations/bookingpal_listing_room_setting_v1.md b/_integrations/bookingpal_listing_room_setting_v1.md
@@ -6,9 +6,17 @@ nav_order: 60
 
 # BookingPal Listing Room Setting (`bookingpal_listing_room_setting_v1`)
 
+{% include enterprise_integration_list.md %}
+
+
 Replicate BookingPal Listing Room Settings into your database.
 
-Docs for this API: [https://www.apimatic.io/apidocs/channelapi/v/2_24](https://www.apimatic.io/apidocs/channelapi/v/2_24)
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create bookingpal_listing_room_setting_v1
+```
+
+Source documentation for this API: [https://www.apimatic.io/apidocs/channelapi/v/2_24](https://www.apimatic.io/apidocs/channelapi/v/2_24)
 
 ## Features
 

diff --git a/_integrations/bookingpal_listing_status_v1.md b/_integrations/bookingpal_listing_status_v1.md
@@ -6,9 +6,17 @@ nav_order: 70
 
 # BookingPal Listing Status (`bookingpal_listing_status_v1`)
 
+{% include enterprise_integration_list.md %}
+
+
 Replicate BookingPal Listing Statuses into your database.
 
-Docs for this API: [https://www.apimatic.io/apidocs/channelapi/v/2_24](https://www.apimatic.io/apidocs/channelapi/v/2_24)
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create bookingpal_listing_status_v1
+```
+
+Source documentation for this API: [https://www.apimatic.io/apidocs/channelapi/v/2_24](https://www.apimatic.io/apidocs/channelapi/v/2_24)
 
 ## Features
 

diff --git a/_integrations/bookingpal_listing_v1.md b/_integrations/bookingpal_listing_v1.md
@@ -6,9 +6,17 @@ nav_order: 80
 
 # BookingPal Listing (`bookingpal_listing_v1`)
 
+{% include enterprise_integration_list.md %}
+
+
 Replicate BookingPal Listings into your database.
 
-Docs for this API: [https://www.apimatic.io/apidocs/channelapi/v/2_24](https://www.apimatic.io/apidocs/channelapi/v/2_24)
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create bookingpal_listing_v1
+```
+
+Source documentation for this API: [https://www.apimatic.io/apidocs/channelapi/v/2_24](https://www.apimatic.io/apidocs/channelapi/v/2_24)
 
 ## Features
 

diff --git a/_integrations/bookingpal_root_v1.md b/_integrations/bookingpal_root_v1.md
@@ -6,8 +6,16 @@ nav_order: 90
 
 # BookingPal Root (`bookingpal_root_v1`)
 
+{% include enterprise_integration_list.md %}
+
+
 This replicator is used to store the authentication secret with BookingPal.
 
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create bookingpal_root_v1
+```
+
 ## Features
 
 <dl>

diff --git a/_integrations/convertkit_broadcast_v1.md b/_integrations/convertkit_broadcast_v1.md
@@ -8,7 +8,12 @@ nav_order: 100
 
 Replicate ConvertKit Broadcasts into your database.
 
-Docs for this API: [https://developers.convertkit.com/#list-broadcasts](https://developers.convertkit.com/#list-broadcasts)
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create convertkit_broadcast_v1
+```
+
+Source documentation for this API: [https://developers.convertkit.com/#list-broadcasts](https://developers.convertkit.com/#list-broadcasts)
 
 ## Features
 

diff --git a/_integrations/convertkit_subscriber_v1.md b/_integrations/convertkit_subscriber_v1.md
@@ -8,7 +8,12 @@ nav_order: 110
 
 Replicate ConvertKit subscribers into a database. This is one of the only ways you can keep track of historical subscriber information with ConvertKit.
 
-Docs for this API: [https://developers.convertkit.com/#list-subscribers](https://developers.convertkit.com/#list-subscribers)
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create convertkit_subscriber_v1
+```
+
+Source documentation for this API: [https://developers.convertkit.com/#list-subscribers](https://developers.convertkit.com/#list-subscribers)
 
 ## Features
 

diff --git a/_integrations/convertkit_tag_v1.md b/_integrations/convertkit_tag_v1.md
@@ -8,7 +8,12 @@ nav_order: 120
 
 Replicate ConvertKit Tags into your database.
 
-Docs for this API: [https://developers.convertkit.com/#list-tags](https://developers.convertkit.com/#list-tags)
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create convertkit_tag_v1
+```
+
+Source documentation for this API: [https://developers.convertkit.com/#list-tags](https://developers.convertkit.com/#list-tags)
 
 ## Features
 

diff --git a/_integrations/email_octopus_campaign_v1.md b/_integrations/email_octopus_campaign_v1.md
@@ -8,7 +8,12 @@ nav_order: 130
 
 Replicate Email Octopus Campaigns into your database.
 
-Docs for this API: [https://emailoctopus.com/api-documentation](https://emailoctopus.com/api-documentation)
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create email_octopus_campaign_v1
+```
+
+Source documentation for this API: [https://emailoctopus.com/api-documentation](https://emailoctopus.com/api-documentation)
 
 ## Features
 

diff --git a/_integrations/email_octopus_contact_v1.md b/_integrations/email_octopus_contact_v1.md
@@ -8,7 +8,12 @@ nav_order: 140
 
 Replicate Email Octopus Contacts into your database.
 
-Docs for this API: [https://emailoctopus.com/api-documentation](https://emailoctopus.com/api-documentation)
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create email_octopus_contact_v1
+```
+
+Source documentation for this API: [https://emailoctopus.com/api-documentation](https://emailoctopus.com/api-documentation)
 
 ## Features
 

diff --git a/_integrations/email_octopus_event_v1.md b/_integrations/email_octopus_event_v1.md
@@ -8,7 +8,12 @@ nav_order: 150
 
 Replicate Email Octopus Events into your database.
 
-Docs for this API: [https://emailoctopus.com/api-documentation](https://emailoctopus.com/api-documentation)
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create email_octopus_event_v1
+```
+
+Source documentation for this API: [https://emailoctopus.com/api-documentation](https://emailoctopus.com/api-documentation)
 
 ## Features
 

diff --git a/_integrations/email_octopus_list_v1.md b/_integrations/email_octopus_list_v1.md
@@ -8,7 +8,12 @@ nav_order: 160
 
 Replicate Email Octopus Lists into your database.
 
-Docs for this API: [https://emailoctopus.com/api-documentation](https://emailoctopus.com/api-documentation)
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create email_octopus_list_v1
+```
+
+Source documentation for this API: [https://emailoctopus.com/api-documentation](https://emailoctopus.com/api-documentation)
 
 ## Features
 

diff --git a/_integrations/front_conversation_v1.md b/_integrations/front_conversation_v1.md
@@ -8,7 +8,12 @@ nav_order: 170
 
 Replicate Front Conversations into your database.
 
-Docs for this API: [https://dev.frontapp.com/reference/conversations](https://dev.frontapp.com/reference/conversations)
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create front_conversation_v1
+```
+
+Source documentation for this API: [https://dev.frontapp.com/reference/conversations](https://dev.frontapp.com/reference/conversations)
 
 ## Features
 

diff --git a/_integrations/front_marketplace_root_v1.md b/_integrations/front_marketplace_root_v1.md
@@ -8,6 +8,11 @@ nav_order: 180
 
 You can replicate your data to WebhookDB Cloud using the Front Marketplace.
 
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create front_marketplace_root_v1
+```
+
 ## Features
 
 <dl>

diff --git a/_integrations/front_message_v1.md b/_integrations/front_message_v1.md
@@ -8,7 +8,12 @@ nav_order: 190
 
 Replicate Front Messages into your database.
 
-Docs for this API: [https://dev.frontapp.com/reference/messages](https://dev.frontapp.com/reference/messages)
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create front_message_v1
+```
+
+Source documentation for this API: [https://dev.frontapp.com/reference/messages](https://dev.frontapp.com/reference/messages)
 
 ## Features
 
@@ -58,4 +63,4 @@ CREATE TABLE public.front_message_v1_fixture (
 );
 ```
 
-{% include prevnext.html prev='_integrations/front_marketplace_root_v1.md' prevLabel='front_marketplace_root_v1' next='_integrations/github_issue_comment_v1.md' nextLabel='github_issue_comment_v1' %}
+{% include prevnext.html prev='_integrations/front_marketplace_root_v1.md' prevLabel='front_marketplace_root_v1' next='_integrations/front_signalwire_message_channel_app_v1.md' nextLabel='front_signalwire_message_channel_app_v1' %}
diff --git a/_integrations/front_signalwire_message_channel_app_v1.md b/_integrations/front_signalwire_message_channel_app_v1.md
@@ -0,0 +1,80 @@
+---
+title: Front/SignalWire Message
+layout: home
+nav_order: 200
+---
+
+# Front/SignalWire Message (`front_signalwire_message_channel_app_v1`)
+
+Replicate Front/SignalWire Messages into your database.
+
+To get set up, run this code from the [WebhookDB CLI](https://webhookdb.com/terminal):
+```
+webhookdb integrations create front_signalwire_message_channel_app_v1
+```
+
+Source documentation for this API: [https://dev.frontapp.com/docs/getting-started-with-partner-channels](https://dev.frontapp.com/docs/getting-started-with-partner-channels)
+
+## Features
+
+<dl>
+<dt>Depends on</dt>
+<dd>To use this replicator, you will need <a href="{% link _integrations/signalwire_message_v1.md %}">signalwire_message_v1</a>. You'll be prompted to create it if you haven't.</dd>
+
+<dt>Supports Webhooks</dt>
+<dd>✅</dd>
+<dt>Supports Backfilling</dt>
+<dd>✅</dd>
+
+</dl>
+
+## Schema
+
+Tables replicated from Front/SignalWire Messages have this schema.
+Note that the data types listed are for Postgres;
+when [replicating to other databases]({% link _concepts/replication_databases.md %}),
+other data types maybe used.
+
+| Column | Type | Indexed |
+| `pk` | `bigint` |  |
+| `external_id` | `text` |  |
+| `signalwire_sid` | `text` | ✅ |
+| `front_message_id` | `text` | ✅ |
+| `external_conversation_id` | `text` | ✅ |
+| `row_updated_at` | `timestamptz` | ✅ |
+| `direction` | `text` |  |
+| `body` | `text` |  |
+| `sender` | `text` |  |
+| `recipient` | `text` |  |
+| `data`* | `jsonb` |  |
+
+<span class="fs-3">* The `data` column contains the raw payload from the webhook or API.
+In many cases there is no canonical form, like if a webhook and API request return
+two different versions of the same resource.
+In that case we try to keep the most coherent and detailed resource."</span>
+
+## Table definition
+
+This definition can also be generated through `webhookdb fixture front_signalwire_message_channel_app_v1`.
+
+```sql
+CREATE TABLE public.front_signalwire_message_channel_app_v1_fixture (
+  pk bigserial PRIMARY KEY,
+  external_id text UNIQUE NOT NULL,
+  signalwire_sid text,
+  front_message_id text,
+  external_conversation_id text,
+  row_updated_at timestamptz,
+  direction text,
+  body text,
+  sender text,
+  recipient text,
+  data jsonb NOT NULL
+);
+CREATE INDEX IF NOT EXISTS svi_fixture_signalwire_sid_idx ON public.front_signalwire_message_channel_app_v1_fixture (signalwire_sid);
+CREATE INDEX IF NOT EXISTS svi_fixture_front_message_id_idx ON public.front_signalwire_message_channel_app_v1_fixture (front_message_id);
+CREATE INDEX IF NOT EXISTS svi_fixture_external_conversation_id_idx ON public.front_signalwire_message_channel_app_v1_fixture (external_conversation_id);
+CREATE INDEX IF NOT EXISTS svi_fixture_row_updated_at_idx ON public.front_signalwire_message_channel_app_v1_fixture (row_updated_at);
+```
+
+{% include prevnext.html prev='_integrations/front_message_v1.md' prevLabel='front_message_v1' next='_integrations/github_issue_comment_v1.md' nextLabel='github_issue_comment_v1' %}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		{: .enterprise }
		<i class="fa-solid fa-crown text-yellow-100"></i> This integration is included in [WebhookDB Enterprise]({% link docs/enterprise.md %}).