Skip to content
v2Latest
Feedback

Webhooks: receive deployment events

Get an HTTPS POST when deployments start, succeed or fail, and verify each signature.

On this page

Webhooks notify your own systems about events in your workspace in real time.

Add an endpoint#

Open Settings → Webhooks, enter an HTTPS URL and choose the events to send.

Event types#

  • deployment.created
  • deployment.succeeded
  • deployment.failed
  • domain.verified

Verify the signature#

Each request has an Acme-Signature header: an HMAC-SHA256 of the raw body using your endpoint secret.

Shell
import crypto from 'node:crypto';

export function verify(rawBody, header, secret) {
  const expected = crypto.createHmac('sha256', secret).update(rawBody).digest('hex');
  return crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(header));
}

Retries#

If your endpoint does not answer with a 2xx status within 10 seconds, we retry up to eight times over 24 hours.

Was this article helpful?

94% found this helpful