Docs

Getting started

Create an integration

Register the external workflow Seamward will observe.

Before you begin

  • Owner or admin access to a workspace
  • One external workflow with a stable owner
  • The provider name and traffic direction

Integration boundary

Choose one external workflow with a clear business outcome.

Create one integration for one externally owned workflow, such as inbound candidate results or outbound payment creation. Do not combine unrelated providers or business outcomes in one integration.

Create the integration

Name the provider in the environment selected in the workspace header.

  1. Open Integrations from the sidebar.
  2. Click the Connect integration button in the page header.
  3. Enter the Integration name and provider, choose the traffic direction, then click the Create integration button at the bottom of the form. Seamward uses the environment selected in the workspace header.
  4. Seamward opens the integration's permanent Collector setup tab. Refreshing the page or selecting Continue setup from the integration list returns to that same setup state.

Save the key

Copy the integration key into the observed handler configuration.

The Collector setup tab provides one public Connection key and one secret ingest token for this Integration. The connection key routes observations and grants no access by itself. The ingest token is shown only when issued or rotated.

Register a contract

Import operation schemas when you have a declared contract.

A contract is optional for ingestion. When you have OpenAPI or JSON Schema, open the integration's Contracts tab and register it so structural analysis can compare each observation with the schema for its operation.