Skip to content

Webhook and Auto Deploy

Nick edited this page Mar 8, 2026 · 2 revisions

Webhook & Auto-Deploy

Dispatch exposes a webhook endpoint that Telex calls whenever a new build is published. When it fires, Dispatch automatically updates the matching project — no manual action needed.

Setup

1. Get your webhook URL and secret

In your WordPress admin, go to Dispatch → Settings → Webhook. Copy the:

  • Webhook URL: https://yoursite.com/wp-json/telex/v1/deploy
  • Webhook Secret: generated by Dispatch and stored encrypted

2. Register in Telex

In your Telex project settings, add a webhook:

  • URL: your webhook URL
  • Secret: your webhook secret
  • Events: build.published

3. Test it

Click Test in Telex to send a test payload. Dispatch validates the signature and returns 200 OK. Confirm receipt in the Dispatch activity log.

Security

Check Detail
HMAC-SHA256 signature Request must include a valid X-Telex-Signature header
Replay prevention Requests older than 5 minutes are rejected
Rate limiting Excessive requests from the same IP are throttled

See Security Model for full details.

Regenerating the Secret

If your secret is compromised, go to Dispatch → Settings → Webhook → Regenerate Secret. Update the secret in Telex immediately — old signatures are rejected as soon as the secret changes.

Troubleshooting

401 response — Signature is invalid. Confirm the secret in Telex exactly matches the one shown in Dispatch.

410 response — Timestamp is too old. Check your server's clock is NTP-synced.

No update triggered — Check the activity log for an error entry. The circuit breaker may be open — run wp telex circuit status to check.

Clone this wiki locally