Introduction to Webhooks
A webhook lets Remote push events to your application the moment something changes, so you do not have to poll the API. You tell Remote which events you care about and where to send them, and Remote sends a signed HTTPS request to that URL every time a matching event fires. The payload carries the same data you would read from the API, delivered as it happens.
This section covers the whole path, from choosing events to processing deliveries safely. If you are new to webhooks on Remote, start here.
How it fits together
Three steps take you from picking events to a working integration:
- Subscribe. Tell Remote which events you want and which URL to call.
- Receive. Stand up an endpoint that accepts the deliveries and responds quickly.
- Verify. Confirm each delivery is genuine before you act on it.
When you pick events in step 1, Available Webhooks is the full catalog of event types to choose from.
What to know up front
A few things shape how you build the receiving side. Each is covered in depth on the page noted:
- Every delivery is signed. Remote signs each request so you can confirm it came from Remote and not a bad actor. Verify the signature before you trust the body. See Verifying Webhooks.
- Webhooks belong to a company. Each subscription is scoped to a single company. There is no global or partner-level webhook outside a company context. See Subscribing to Webhooks.
- Delivery is at-least-once. The same event can arrive more than once because of retries, replays, or network hiccups. De-duplicate on the event id and make your processing idempotent. See Receiving Webhooks.
- Failed deliveries retry on a schedule. Remote retries a delivery only when it cannot reach your endpoint, up to 5 times over 18 hours. A
4xxor5xxresponse counts as delivered and is not retried. See Receiving Webhooks. - Test in Sandbox first. Fire test deliveries against your endpoint in Sandbox before you register a production callback. See Receiving Webhooks.
Next steps
- Subscribing to Webhooks: register, update, list, and delete your subscriptions.
- Receiving Webhooks: accept deliveries, respond, and recover missed events.
- Verifying Webhooks: the signature check every receiver must perform.
- Available Webhooks: the full list of event types.
Updated 1 day ago