Skip to main content

Overview

This document describes the Beneficiary Syncronization webhook event, where the Service Provider subscribes to the BENEFICIARY_SYNC event in AccessRC. When the Program Manager hits sync Sync Beneficiaries for an application group that the Service Provider is configured for, AccessRC sends a webhook call to the callback service of the Service Provider with the beneficiary metadata for integration.
⚠️ Warning
Not implemented yet.

Event Flow: AccessRC → Service Provider

  1. Service Provider subscribes to the BENEFICIARY_SYNC event.
  2. When Program Manager hits sync Beneficiaries, AccessRC sends a webhook call to the service provider’s callback URL.
  3. The Service Provider processes the details of the beneficiaries and integrates it into their system.

Webhook Request Payload

Webhook Response Payload

200 Response

A successful callback response from the Service Provider’s callback service.

400 Response

If the validation fails or there is a bad request, the response will be:

401 Response

If the verification fails, the response will be:

500 Response

In case of an internal server error, the response will be: