Webhooks

Register a webhook (job.complete / job.failed)

Registers an HTTPS endpoint that receives a POST when one of your jobs finishes. Body: {"event": "job.complete" | "job.failed", "data": {...}}. Headers: X-EPWTools-Event and X-EPWTools-Signature: sha256=<hex>, the HMAC-SHA256 of the raw body keyed with your secret. Verify it before trusting the payload, for example in Python: hmac.compare_digest(sig, 'sha256=' + hmac.new(secret.encode(), body, hashlib.sha256).hexdigest()). Delivery is attempted once with a 10 s timeout, so keep polling as a fallback for critical jobs.

post/api/webhooks

Request

  • Base URL: https://epw.tools
  • URL: https://epw.tools/api/webhooks
  • Auth: none declared. Required headers: X-API-Key

Headers

X-API-Keystring required

Request body

urlstring required
secretstring required

Shared secret used to sign the HMAC-SHA256 delivery header.

eventsstring

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.