Skip to main content
Webhooks belong to the Carrier & MGA API. Subscribe in the Turris app under Settings, Developer, Webhook. The API lists your webhooks and sends test events; it does not create subscriptions.

Overview

The APPOINTMENT_REQUEST_STATUS_CHANGE webhook tells you that one of your appointment requests moved to a new status: Turris operations filed it with the state, the state granted the appointment, the request was cancelled, and so on. It lets your system react as a request moves instead of polling for every change: create it with Request an Appointment, then handle this event. Webhook type: APPOINTMENT_REQUEST_STATUS_CHANGE

Triggers

This webhook fires when the status of an existing appointment request changes, whoever changed it:
  • Turris operations moves it in the Turris admin console, one request at a time or in bulk
  • Turris completes it automatically when the appointment appears in the state’s records (completed)
  • someone cancels it: through Cancel an Appointment Request, in the Turris app, in bulk, or Turris cancels it because a product was unassigned or because another of your requests already covers the same NPN, state and carrier (canceled)
It does not fire when a request is created. Every request starts as pending, and the call that creates it already returns it. A request created in the Turris app is therefore first announced by its first status change; use List Appointment Requests to see requests you have not heard about yet. A bulk change sends one event per request. Writing the status a request already has sends nothing.
This webhook is sent immediately. No debouncing is applied: each status change is a discrete event.

Payload Example

Payload Fields

Deliveries can repeat and can arrive out of order. A failed delivery is retried and can land after a newer one, and in rare cases the same change is delivered twice. Key your processing on appointmentRequestId and keep the event with the latest statusChangedAt; ignore an older one. When in doubt, Get an Appointment Request returns the current status.A delivery can also be missed, for example during an outage on our side, and a missed event is not always available to resend. Treat these events as a prompt rather than a ledger: the request’s status on List Appointment Requests is the source of truth, so reconcile against it from time to time.downstreamEntityAssociationId is resolved when the event is sent, so two events for one request can carry different association ids if the agency was archived and associated again in between.A request made for one of your child organizations is delivered to the child’s webhooks, not the parent’s.