Hodoflow / Developers
Sign in
Browse documentation
Help Center →
Browse API reference

JSON:API · v1

Integrations

Inspect connectors, API specifications, and delivery failures.

Bearer authentication api_read / api_write by operation Stable

Operations

GET List aPI specifications /api/json/v1/api_specs List aPI specifications visible to the authenticated service account. POST Create a aPI specification /api/json/v1/api_specs Create a new aPI specification in the service account's workspace. GET Retrieve a aPI specification /api/json/v1/api_specs/{id} Retrieve one aPI specification visible to the authenticated service account. PATCH Update a aPI specification /api/json/v1/api_specs/{id} Update the supported fields of one aPI specification. GET List dead-letter messages /api/json/v1/dead_letter_messages List dead-letter messages visible to the authenticated service account. GET Retrieve a dead-letter message /api/json/v1/dead_letter_messages/{id} Retrieve one dead-letter message visible to the authenticated service account. GET List external connectors /api/json/v1/external_connectors List external connectors visible to the authenticated service account. GET Retrieve a external connector /api/json/v1/external_connectors/{id} Retrieve one external connector visible to the authenticated service account.

Objects and fields

These are the reviewed public attributes. Fields omitted from this contract are not part of the API, even when they exist internally.

API specification type: api_spec 11 fields

Public JSON:API resource object for aPI specifications.

Field Type Presence Description
external_connector_id string | null Optional · nullable Attached external connector identifier, when configured.
format enum: json | yaml Required Serialization of the uploaded document. Field included by default.
name string Required Human label for the imported spec, e.g. 'Stripe API'. Field included by default.
openapi_version string | null Optional · nullable Declared spec version, e.g. '3.0.3', '3.1.0', or '2.0' (Swagger). Field included by default.
operations array<object> Required Normalized operations from the Parser. Each: operation_ref, method, path, params, request_schema, response_schema, request_fingerprint, response_fingerprint.
organization_id string Required Organization that owns the resource.
raw_document string Required The original uploaded document, verbatim (JSON or YAML text).
security_schemes object Required components.securitySchemes from the spec; informs connector auth_type. Field included by default.
servers array<object> Required Normalized server entries (%{"url" => ..., "description" => ...}). Field included by default.
title string | null Optional · nullable info.title from the spec. Field included by default.
version string | null Optional · nullable info.version from the spec. Field included by default.
Dead-letter message type: dead_letter_message 7 fields

Public JSON:API resource object for dead-letter messages.

Field Type Presence Description
connector_id string | null Optional · nullable Connector id returned by the public contract.
error string Required Last error reason. Field included by default.
organization_id string Required Organization that owns the resource.
retry_count integer Required Retry count returned by the public contract.
source enum: kafka | webhook Required Source returned by the public contract.
status enum: pending | permanently_failed Required Current outcome status.
trigger_id string Required Trigger id returned by the public contract.
External connector type: external_connector 11 fields

Public JSON:API resource object for external connectors.

Field Type Presence Description
auth_type enum: none | oauth2 | api_key | bearer_token | basic_auth | hmac Required Auth type returned by the public contract.
config object | null Optional · nullable Stores base_url, region, client_id, etc. A `rate_limit` block here caps how fast workflow steps may call this provider — see `Dash.Workflows.RateLimiter`. Field included by default.
connector_schema array<object> | null Optional · nullable Sampled source schema (field shapes) associated with this connector; copied into Workflow.data_schema on workflow creation against the connector. Field included by default.
description string | null Optional · nullable Optional notes can describe the connector's purpose, owner, and related runbooks. Field included by default.
direction enum: inbound | outbound | null Optional · nullable Direction returned by the public contract.
name string Required e.g., 'Shopify Production' or 'SendGrid API'. Field included by default.
organization_id string Required Organization that owns the resource.
schema_fingerprint string | null Optional · nullable Opaque hash of the connector's identity-affecting config at the time of the last sample; used to detect drift. Field included by default.
schema_sampled_at object | null Optional · nullable Timestamp of the last successful schema sample for this connector. Field included by default.
status enum: unverified | verified | failing | null Optional · nullable Current outcome status.
type enum: http | s3 | kafka | postgres_cdc | snowflake | null Optional · nullable Determines which driver handles the connection. Field included by default.