Skip to main content

Webhook Event Reference

All event types delivered by Ummat webhooks, with example payloads.

Event types

TypeTriggerRequired scope
event.createdA new event is published by an entityevents:read
event.cancelledA published event is cancelledevents:read
prayer_times.updatedAn entity updates their iqamah scheduleprayer-times:read
donation.completedA donation is marked as completeddonations:read
donation.refundedA donation is refundeddonations:read
member.addedA user is added to an entitymembers:read
member.removedA user is removed from an entitymembers:read
claim.approvedAn entity verification claim is approvedentity:read
claim.rejectedAn entity verification claim is rejectedentity:read
service.degradedUmmat API service degradation detectednone

event.created

{
  "id": "evt_01hzxxxxx",
  "type": "event.created",
  "created_at": "2026-05-03T14:22:00Z",
  "api_version": "2026-05",
  "data": {
    "event_id": "uuid",
    "entity_id": "uuid",
    "title": "Jumuah Khutbah",
    "starts_at": "2026-05-10T12:30:00Z",
    "ends_at": "2026-05-10T13:30:00Z",
    "is_online": false,
    "location": "Main Prayer Hall"
  }
}

event.cancelled

{
  "type": "event.cancelled",
  "data": {
    "event_id": "uuid",
    "entity_id": "uuid",
    "title": "Jumuah Khutbah",
    "cancelled_at": "2026-05-09T18:00:00Z",
    "reason": "Unforeseen circumstances"
  }
}

prayer_times.updated

{
  "type": "prayer_times.updated",
  "data": {
    "entity_id": "uuid",
    "schedule_id": "uuid",
    "effective_from": "2026-05-01",
    "effective_until": null,
    "is_ramadan_override": false,
    "fajr": "05:15",
    "dhuhr": "13:00",
    "asr": "16:30",
    "maghrib": "sunset",
    "isha": "21:00",
    "jumuah_1": "13:00",
    "jumuah_2": null
  }
}

donation.completed

{
  "type": "donation.completed",
  "data": {
    "donation_id": "uuid",
    "entity_id": "uuid",
    "amount_cents": 5000,
    "currency": "USD",
    "fund_designation": "General",
    "completed_at": "2026-05-03T14:22:00Z"
  }
}

member.added / member.removed

{
  "type": "member.added",
  "data": {
    "entity_id": "uuid",
    "user_id": "uuid",
    "role": "admin",
    "added_at": "2026-05-03T14:22:00Z"
  }
}

service.degraded

Sent to all active webhook subscriptions when Ummat detects an API service degradation. No scope required.

{
  "type": "service.degraded",
  "data": {
    "service": "graphql",
    "severity": "partial",
    "message": "Elevated error rates detected on GraphQL endpoint",
    "status_url": "https://status.ummat.dev"
  }
}