Pull Endpoint Lifecycle

Why You Would Use This

Pull endpoint lifecycle is how you control which providers can send events to HookBridge for pull-based retrieval, and when an endpoint should stop accepting new events.

When you create a pull endpoint, HookBridge returns an ingest_url and secret_token once. Store both securely because external providers use the ingest URL to send events into your pipeline.

Console Workflow

1. Open Endpoints and switch to the Pull tab.
2. Click Create Pull Endpoint.
3. Set a name, description, and optional retention period.
4. Configure event type extraction if your provider includes event types in the payload or headers.
5. Configure verification settings if needed.
6. Save and copy the generated ingest_url. It is only shown once.
7. Give the ingest_url to your external provider as the webhook destination.

To manage an existing pull endpoint:

• Open the endpoint detail page to view settings and event counts.
• Use Pause to temporarily reject new incoming webhooks (the provider receives a 503 and retries later).
• Use Resume to start accepting events again.
• Use Delete to permanently retire the endpoint.

Behavior Notes

• pause causes new incoming webhooks to be rejected with a 503 status. Existing stored events remain retrievable.
• resume starts accepting new incoming webhooks again.
• delete removes the endpoint. It no longer accepts new webhooks, and stored events become inaccessible.

API Workflow

API reference:

• Create pull endpoint
• List pull endpoints
• Get pull endpoint
• Update pull endpoint
• Pause pull endpoint
• Resume pull endpoint
• Delete pull endpoint

# Create pull endpoint
curl -X POST https://api.hookbridge.io/v1/pull-endpoints \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Stripe Order Events",
    "description": "Batch processor for Stripe order events",
    "retention_days": 30,
    "event_type_source": "body",
    "event_type_path": "type"
  }'

# List pull endpoints
curl https://api.hookbridge.io/v1/pull-endpoints \
  -H "Authorization: Bearer YOUR_API_KEY"

# Get pull endpoint (includes event counts)
curl https://api.hookbridge.io/v1/pull-endpoints/YOUR_PULL_ENDPOINT_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

# Update pull endpoint
curl -X PATCH https://api.hookbridge.io/v1/pull-endpoints/YOUR_PULL_ENDPOINT_ID \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"description": "Updated description", "retention_days": 60}'

# Pause pull endpoint
curl -X POST https://api.hookbridge.io/v1/pull-endpoints/YOUR_PULL_ENDPOINT_ID/pause \
  -H "Authorization: Bearer YOUR_API_KEY"

# Resume pull endpoint
curl -X POST https://api.hookbridge.io/v1/pull-endpoints/YOUR_PULL_ENDPOINT_ID/resume \
  -H "Authorization: Bearer YOUR_API_KEY"

# Delete pull endpoint
curl -X DELETE https://api.hookbridge.io/v1/pull-endpoints/YOUR_PULL_ENDPOINT_ID \
  -H "Authorization: Bearer YOUR_API_KEY"