Fivetrex.Models.WebhookEvent (Fivetrex v0.2.1)

View Source

Represents an incoming Fivetran webhook event payload.

When Fivetran sends a webhook notification to your endpoint, the payload contains information about what triggered the event. Use this struct to parse and work with webhook payloads in a typed manner.

Fields

  • :event - Event type (e.g., "sync_start", "sync_end")
  • :created - DateTime when the event was created (parsed from ISO 8601)
  • :connector_id - The connector that triggered the event
  • :connector_type - Connector service type (e.g., "postgres", "salesforce")
  • :group_id - Group containing the connector
  • :data - Event-specific data (varies by event type)

Event Types

  • "sync_start" - Connector sync started
  • "sync_end" - Connector sync completed (check data for success/failure)
  • "status" - Connector status changed
  • "dbt_run_start" - dbt transformation started
  • "dbt_run_succeeded" - dbt transformation succeeded
  • "dbt_run_failed" - dbt transformation failed

Data Field

The :data field contains event-specific information. For sync_end events, it typically includes:

%{
  "status" => "SUCCESSFUL",  # or "FAILURE_WITH_TASK"
  "reason" => nil            # Error message on failure
}

Helper Functions

This module provides convenience functions to check event types:

if WebhookEvent.sync_end?(event) do
  handle_sync_completion(event)
end

Examples

Parsing a webhook payload in a Phoenix controller:

def receive(conn, params) do
  event = Fivetrex.Models.WebhookEvent.from_map(params)

  case event.event do
    "sync_end" ->
      IO.puts("Sync finished for connector: #{event.connector_id}")
    "sync_start" ->
      IO.puts("Sync started for connector: #{event.connector_id}")
    _ ->
      IO.puts("Received event: #{event.event}")
  end

  json(conn, %{status: "ok"})
end

Filtering for specific events:

if WebhookEvent.sync_end?(event) do
  process_completed_sync(event.connector_id, event.data)
end

See Also

Summary

Types

t()

A Fivetran Webhook Event struct.

Functions

from_map(map)

Converts a map (from webhook JSON payload) to a WebhookEvent struct.

sync_end?(webhook_event)

Returns true if this is a sync_end event.

sync_start?(webhook_event)

Returns true if this is a sync_start event.

Types

t()

@type t() :: %Fivetrex.Models.WebhookEvent{
  connector_id: String.t() | nil,
  connector_type: String.t() | nil,
  created: DateTime.t() | nil,
  data: map() | nil,
  event: String.t() | nil,
  group_id: String.t() | nil
}

A Fivetran Webhook Event struct.

All fields may be nil if not provided in the webhook payload.

Functions

from_map(map)

@spec from_map(map()) :: t()

Converts a map (from webhook JSON payload) to a WebhookEvent struct.

This function parses incoming webhook payloads into typed structs for easier processing.

Parameters

  • map - A map with string keys from a decoded JSON webhook payload

Returns

A %Fivetrex.Models.WebhookEvent{} struct with fields populated from the map.

Examples

iex> map = %{"event" => "sync_end", "connector_id" => "conn_123"}
iex> event = Fivetrex.Models.WebhookEvent.from_map(map)
iex> event.event
"sync_end"

sync_end?(webhook_event)

@spec sync_end?(t()) :: boolean()

Returns true if this is a sync_end event.

Sync end events indicate a connector has finished syncing. Check the data field for success/failure status.

Parameters

  • event - A %Fivetrex.Models.WebhookEvent{} struct

Returns

  • true - If the event type is "sync_end"
  • false - Otherwise

Examples

iex> event = %Fivetrex.Models.WebhookEvent{event: "sync_end"}
iex> Fivetrex.Models.WebhookEvent.sync_end?(event)
true

# Check if sync was successful
if WebhookEvent.sync_end?(event) do
  case event.data do
    %{"status" => "SUCCESSFUL"} -> handle_success(event)
    %{"status" => "FAILURE_WITH_TASK"} -> handle_failure(event)
  end
end

sync_start?(webhook_event)

@spec sync_start?(t()) :: boolean()

Returns true if this is a sync_start event.

Parameters

  • event - A %Fivetrex.Models.WebhookEvent{} struct

Returns

  • true - If the event type is "sync_start"
  • false - Otherwise

Examples

iex> event = %Fivetrex.Models.WebhookEvent{event: "sync_start"}
iex> Fivetrex.Models.WebhookEvent.sync_start?(event)
true