Skip to main content

Endpoints

Endpoints are the entry points where Zen Mesh receives webhook events from external sources.

What Is an Endpoint?​

An endpoint (also called an ingester) is a configuration that defines how Zen Mesh receives events from a specific source. Each endpoint specifies the source type, authentication method, and processing rules.

Creating an Endpoint​

Via Dashboard​

  1. Navigate to Sources → Add Source
  2. Select the provider type (Stripe, GitHub, Generic HTTP, etc.)
  3. Configure the source settings:
    • Name: A descriptive identifier (e.g., stripe-prod)
    • Hook URL: The ingestion URL provided by Zen Mesh
    • Verification: Signature verification method (HMAC, Stripe signing secret, etc.)
  4. Save the endpoint

Via API​

curl -X POST https://api.zen-mesh.io/v1/tenants/{tenant}/ingesters \
  -H "Authorization: Bearer {api_key}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "stripe-prod",
    "provider": "stripe",
    "config": {
      "signing_secret": "whsec_..."
    }
  }'

Endpoint Configuration​

SettingDescriptionRequired
NameHuman-readable identifier for the endpointYes
ProviderEvent source type (stripe, github, generic, etc.)Yes
VerificationSignature or header validation methodRecommended
Delivery FlowOne or more delivery flows that process eventsYes
FiltersEvent filtering conditions (event type, headers)Optional

Managing Endpoints​

Listing Endpoints​

curl https://api.zen-mesh.io/v1/tenants/{tenant}/ingesters \
  -H "Authorization: Bearer {api_key}"

Updating an Endpoint​

curl -X PUT https://api.zen-mesh.io/v1/tenants/{tenant}/ingesters/{id} \
  -H "Authorization: Bearer {api_key}" \
  -H "Content-Type: application/json" \
  -d '{"name": "stripe-prod-v2", ...}'

Deleting an Endpoint​

curl -X DELETE https://api.zen-mesh.io/v1/tenants/{tenant}/ingesters/{id} \
  -H "Authorization: Bearer {api_key}"

Connection Between Endpoints, Destinations, and Delivery Flows​

  • Endpoint: Where events enter Zen Mesh
  • Delivery Flow: Routing rules connecting endpoints to destinations
  • Destination: Where events are delivered (your internal service)

Events flow: Source → Endpoint → Delivery Flow → Destination