Skip to main content

CreateWebhookInput

Input for creating a webhook subscription.

Integration guide: Webhooks guide

Interactive mutation builder: Create Webhook mutation builder

eventTypes​

Use lowercase dotted strings. These are the same values returned in delivered webhook payloads (eventType). Subscribe to each event you need; event types do not overlap (for example, booking.updated does not include patient journey events).

Valid values:

  • availability.blocker.created
  • availability.blocker.removed
  • availability.blocker.updated
  • availability.recurring.created
  • availability.recurring.removed
  • availability.recurring.updated
  • availability.specific.created
  • availability.specific.removed
  • availability.specific.updated
  • booking.created
  • booking.deleted
  • booking.patientJourney.arrived
  • booking.patientJourney.completed
  • booking.patientJourney.inConsultation
  • booking.patientJourney.noShow
  • booking.updated
  • episode.created
  • episode.deleted
  • episode.updated
  • clinicalReport.submittedForApproval
  • invoice.created
  • invoice.deleted
  • invoice.integrations.healthcode.statusUpdated
  • invoice.integrations.xero.synced
  • invoice.lineItems.added
  • invoice.lineItems.removed
  • invoice.paid
  • invoice.partiallyPaid
  • invoice.refunded
  • invoice.shared
  • invoice.updated
  • lab.created
  • lab.results.added
  • letter.created
  • letter.deleted
  • letter.reviewStatus.updated
  • letter.shared
  • location.created
  • location.deleted
  • location.updated
  • locationGroup.created
  • locationGroup.deleted
  • locationGroup.updated
  • patient.archived
  • patient.created
  • patient.customAttribute.added
  • patient.customAttribute.removed
  • patient.customAttribute.updated
  • patient.deleted
  • patient.label.added
  • patient.label.removed
  • patient.membership.updated
  • patient.merged
  • patient.number.added
  • patient.number.removed
  • patient.number.updated
  • patient.phone.added
  • patient.phone.removed
  • patient.phone.updated
  • patient.relationship.added
  • patient.relationship.removed
  • patient.relationship.updated
  • patient.unarchived
  • patient.updated
  • patientDocument.deleted
  • patientDocument.renamed
  • patientDocument.uploadInitiated
  • pathway.booking.assigned
  • pathway.booking.unassigned
  • pathway.created
  • pathway.deleted
  • pathway.updated
  • prescription.created
  • prescription.deleted
  • prescription.eprescription.generated
  • prescription.ordered
  • prescription.recordedInError
  • prescription.shared
  • product.label.added
  • product.label.removed
  • questionnaire.response.received
input CreateWebhookInput {
  url: String!
  eventTypes: [String!]!
  label: String!
  headers: [WebhookHeaderInput!]
}

Fields​

CreateWebhookInput.url ● String! non-null scalar​

Destination URL (HTTPS only).

CreateWebhookInput.eventTypes ● [String!]! non-null scalar​

Event types to subscribe to. See CreateWebhookInput for the full list of valid values.

CreateWebhookInput.label ● String! non-null scalar​

Short label to identify this subscription (e.g. in your admin UI).

CreateWebhookInput.headers ● [WebhookHeaderInput!] list input​

Optional headers to include on each webhook delivery.

Member Of​

createWebhook mutation