Skip to content
Proud to collaborate with Microsoft for Startups

cloudflare.pages.add-domain ​

Bind a custom domain to a Cloudflare Pages project and wait for SSL/validation to become active.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-cloudflare
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID.
connection_uuiduuidYes—Cloudflare CloudConnection UUID.
project_namestringYes—Pages project name.
domainstringYes—Custom domain to bind (e.g. calendar.senai.example).
wait_activebooleanNo—Poll until the domain becomes active; default true.
timeout_secondsintegerNo—Max seconds to wait for activation; default 300.

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Echoed organization UUID.
project_namestringNo—Pages project name.
domainstringNo—Bound domain.
domain_statusstringNo—Domain/certificate status (pending, active).
verification_datajsonNo—Any DNS/ownership records the caller must create.
statusstringNo—Workflow status.
completed_atstringNo—ISO8601 timestamp when the workflow completed.
failure_reasonstringNo—Engine-stamped human-readable failure reason
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped step name (DAG path)
failed_layerintegerNo—Engine-stamped layer index (DAG path)
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name
failure_typestringNo—Engine-stamped failure category (atomic path)
failed_actionstringNo—Engine-stamped action method that raised (atomic path)

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—addInputs accepted
activatingNoNo——Domain bound; waiting for activation via scheduled polling
completedNoYesYes—Domain active and persisted
failedNoYesNo—Domain binding/activation failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingaddactivating—
activatingpollactivating—
activatingpersistcompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "cloudflare.pages.add-domain",
  "initial_data": {
    "organization_uuid": "value",
    "connection_uuid": "value",
    "project_name": "value",
    "domain": "value"
  }
}