cliDeterministic

Create webhook endpoint

pipeline create-webhook-endpoint

Create an HTTPS webhook endpoint with explicit event subscriptions and optional campaign filters and destination authentication. Returns a signing secret once.

Parameters

workspaceId

string

No description.

namerequired

string

No description.

urlrequired

string

No description.

eventTypesrequired

string[]

No description.

filters

object

No description.

destinationAuth

unknown

No description.

active

boolean

No description.

Example

CLI commandbash

pipeline create-webhook-endpoint \
  --name "example" \
  --url "https://example.com" \
  --event-types "campaign.started"

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "workspaceId": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "eventTypes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "filters": {
          "type": "object"
        },
        "apiVersion": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "paused",
            "auto_paused"
          ]
        },
        "pauseReason": {
          "type": [
            "string",
            "null"
          ]
        },
        "health": {
          "type": "string",
          "enum": [
            "never_delivered",
            "healthy",
            "failing"
          ]
        },
        "destinationAuth": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string"
            },
            "headerName": {
              "type": [
                "string",
                "null"
              ]
            },
            "configured": {
              "type": "boolean"
            }
          },
          "required": [
            "type",
            "headerName",
            "configured"
          ]
        },
        "consecutiveFailures": {
          "type": "number"
        },
        "lastSuccessAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "lastFailureAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "lastError": {
          "type": [
            "string",
            "null"
          ]
        },
        "createdAt": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "workspaceId",
        "name",
        "url",
        "eventTypes",
        "filters",
        "apiVersion",
        "status",
        "pauseReason",
        "health",
        "destinationAuth",
        "consecutiveFailures",
        "lastSuccessAt",
        "lastFailureAt",
        "lastError",
        "createdAt",
        "updatedAt"
      ]
    },
    "signingSecret": {
      "type": "string"
    }
  },
  "required": [
    "endpoint",
    "signingSecret"
  ]
}

Exit codes

1: Invalid input or local configuration.
2: The API or tool returned an error.
3: Authentication failed.
4: A network request failed.