Email Octopus Event (email_octopus_event_v1)

Replicate Email Octopus Events into your database.

To get set up, run this code from the WebhookDB CLI:

webhookdb integrations create email_octopus_event_v1

Source documentation for this API: https://emailoctopus.com/api-documentation

Features

Depends on
To use this replicator, you will need email_octopus_list_v1. You'll be prompted to create it if you haven't.
Supports Webhooks
✅
Supports Backfilling
✅

Schema

Tables replicated from Email Octopus Events have this schema. Note that the data types listed are for Postgres; when replicating to other databases, other data types maybe used.

Column Type Indexed
pk bigint  
unique_id uuid  
email_octopus_contact_id text  
contact_email_address text  
email_octopus_campaign_id text  
event_type text  
occurred_at timestamptz ✅
data* jsonb  

* 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.”

Table definition

This definition can also be generated through webhookdb fixture email_octopus_event_v1.

CREATE TABLE public.email_octopus_event_v1_fixture (
  pk bigserial PRIMARY KEY,
  unique_id uuid UNIQUE NOT NULL,
  email_octopus_contact_id text,
  contact_email_address text,
  email_octopus_campaign_id text,
  event_type text,
  occurred_at timestamptz,
  data jsonb NOT NULL
);
CREATE INDEX IF NOT EXISTS svi_fixture_occurred_at_idx ON public.email_octopus_event_v1_fixture (occurred_at);
← email_octopus_contact_v1email_octopus_list_v1 →