Skip to main content

Webhooks

Network

Webhooks allow Apostolic Path to automatically notify your external systems when events happen in your church's account. This enables real-time integrations without polling the API.

What Are Webhooks?​

A webhook is an HTTP callback — when something happens in Apostolic Path (like a new student being added), the platform sends a POST request to a URL you specify, containing details about the event.

Creating a Webhook​

  1. Navigate to Settings > Webhooks
  2. Click Create Webhook
  3. Configure the webhook:
    • URL — The endpoint that will receive webhook events
    • Events — Select which events should trigger the webhook
  4. Click Create

Available Events​

You can subscribe to events such as:

  • Student created — A new student is added
  • Student updated — A student's information changes
  • Milestone completed — A New Birth milestone is recorded
  • First Step completed — A student completes a First Step
  • Study created/updated — Bible study changes
  • Class enrollment — A student enrolls in a class
  • Attendance recorded — Class attendance is saved

Webhook Security​

All webhooks are signed with HMAC (Hash-based Message Authentication Code) so you can verify that incoming requests genuinely came from Apostolic Path:

  1. When you create a webhook, a signing secret is generated
  2. Each webhook request includes a signature header
  3. Your application should verify the signature using the shared secret

Webhook Reliability​

Apostolic Path ensures reliable webhook delivery:

  • Automatic retries — If your endpoint returns an error, the webhook is retried with exponential backoff
  • Auto-disable — If a webhook consistently fails, it will be automatically disabled to prevent unnecessary load
  • Delivery logs — View the delivery status of recent webhook events

Testing a Webhook​

After creating a webhook, you can send a test event to verify your endpoint is receiving and processing events correctly:

  1. Find the webhook in your list
  2. Click Test
  3. A sample event will be sent to your URL
  4. Check the delivery status to confirm it was received

Managing Webhooks​

  • Edit a webhook to change its URL or subscribed events
  • Disable a webhook temporarily without deleting it
  • Delete a webhook to permanently remove it
  • View logs to see recent delivery attempts and statuses