Skip to content

Latest commit

 

History

History
222 lines (156 loc) · 4.81 KB

README.md

File metadata and controls

222 lines (156 loc) · 4.81 KB

Embed Workflow Ruby Library

The Embed Workflow Ruby library provides convenient access to the Embed Workflow API from applications written in the Ruby language.

Documentation

See the Ruby API docs.

Installation

To install this gem:

gem install embed-workflow

or if you are adding it via bundler then add it to your gemfile:

gem "embed-workflow"

Configuration

Configure EmbedWorkflow by setting the publishable and secret keys. Be sure to follow best practices and keep your secret key secure.

require "embed_workflow"

EmbedWorkflow.skey = "sk_live_REPLACE_ME"

Pagination

The EmbedWorkflow API uses cursor-based pagination for list endpoints. The following pagination parameters are supported:

  • starting_after: Returns objects after this cursor position (exclusive)
  • ending_before: Returns objects before this cursor position (exclusive)
  • limit: Maximum number of objects to return (defaults to 25 if not specified)

Both cursor parameters take an object ID as their value. The response will include the data array containing the requested objects, along with pagination metadata.

Usage

Create Workflow

template = {
  "edges": ["a-b", "a-c"],
  "nodes": [
    {"id": "a", "name": "Wait 2 hours", "type": "Delay", "delay_n": 2, "delay_unit": "hour"},
    {"id": "b", "name": "Email", "type": "Email", "recipient": "[email protected]", "subject": "New Submission", "body": "New submission from {{Name}} - {{Email}} - {{Phone}}."},
    {"id": "c", "url": "https://domain.com/webhook_example", "name": "Webhook", "type": "Webhook", "params": "one: 1\ntwo: 2", "headers": "X-Custom-Header: my_value"}
  ]
}
EmbedWorkflow::Workflows.create(
  name: "My first workflow",
  template: template
)

Fetch Workflow

EmbedWorkflow::Workflows.fetch(hashid: "nybra")

List Workflows

# Default pagination (25 items)
EmbedWorkflow::Workflows.list

# With pagination parameters
EmbedWorkflow::Workflows.list(starting_after: "550e8400-e29b-41d4-a716-446655440000", limit: 10)

# Filter by user
EmbedWorkflow::Workflows.list(user_key: "api-user-1")

Update Workflow

EmbedWorkflow::Workflows.update(hashid: "nybra", name: "Updated Name")

List Workflow Activities

EmbedWorkflow::Workflows.activities(hashid: "nybra")

Execute Workflow

EmbedWorkflow::Workflows.execute(
  hashid: "79zeo",
  execution: {"Account Email": "[email protected]" },
  form: {
    Name: "David",
    Email: "[email protected]",
    Phone: "954-321-1234"
  }
)

Clone Workflow

EmbedWorkflow::Workflows.clone(hashid: "xbydj")

Run Workflow

workflow = EmbedWorkflow::Workflows.create(name: "Manual Start Workflow", auto_start: false)

EmbedWorkflow::Workflows.run(hashid: workflow["hashid"])

List Action Activities

EmbedWorkflow::Actions.activities(hashid: "7l0al")

Upsert a user

config = {
  user_data: {
    foo: "bar"
  },
}

# Adding a new user
user = EmbedWorkflow::Users.upsert(key: "api-user-1", name: "Jane Doe", email: "[email protected]", config: config)

# Updating a user
EmbedWorkflow::Users.upsert(name: "Jane Smith", id: user["id"], config: config)

Fetch a user

EmbedWorkflow::Users.fetch(key: "api-user-1")

List users

# Default pagination (25 items)
EmbedWorkflow::Users.list

# With pagination parameters
EmbedWorkflow::Users.list(starting_after: "550e8400-e29b-41d4-a716-446655440000", limit: 10)

Delete a user

EmbedWorkflow::Users.delete(key: "api-user-1")

Catch a webhook

EmbedWorkflow.catch_hook(user_key: "main", hook_id: "70e59f4d-1dc4-4720-b0bb-46929dc48d47", anything: "else", you: "need")

App Connections

App Connections allow you to store encrypted credentials for third-party integrations.

List app connections

# Default pagination (25 items)
EmbedWorkflow::AppConnections.list

# With pagination parameters
EmbedWorkflow::AppConnections.list(starting_after: "550e8400-e29b-41d4-a716-446655440000", limit: 50)

# For a specific user
EmbedWorkflow::AppConnections.list(user_key: "api-user-1")

Fetch an app connection

EmbedWorkflow::AppConnections.fetch(id: "75233470-6316-4fa9-a7f5-5196f3d06067")

Create an app connection

config = {
  api_key: "sk-1234567890abcdef",
  organization_id: "org-abcdefg123456"
}

EmbedWorkflow::AppConnections.create(
  name: "My OpenAI Connection",
  app_type: "openai",
  config: config
)

Update an app connection

EmbedWorkflow::AppConnections.update(
  id: "75233470-6316-4fa9-a7f5-5196f3d06067",
  name: "Updated OpenAI Connection"
)

Delete an app connection

EmbedWorkflow::AppConnections.delete(id: "75233470-6316-4fa9-a7f5-5196f3d06067")