A webhook posts data to a URL you control as soon as an event occurs in Amanahfy. This pushes data into your own systems in real time, and you define the payload.
Before you start
You need the Webhook permission. Go to Settings → Webhook to check your access.
You need an endpoint ready to receive an HTTP request, and its URL.
Set up a webhook
Go to Settings → Webhook.
Enter your endpoint URL in the Webhook URL field.
Select either the Donation Format or Fundraiser Format tab to configure the payload.
Map the provided variables to your own JSON keys. For example, map the ID variable to a key like
"id".Click Save Changes at the bottom of the page.
Click Send Test at the top of the page to confirm your endpoint receives the data.
Available variables
The Donation Format tab provides these variables.
ID, Price Point Name, Price Point Amount, Price Point Code, Fundraise Name, Fundraiser Last Name, Currency, Cover Transaction Fee, Gift Aid, Anonymous Donation, Transaction ID, Campaign Title, End Date, Created At, Stripe Payment ID, Frequency, Amanahfy Tip, Tribute, Transaction Fee Amount, Admin Fee, Description, Jummah Description, Amount, Selected Payment, Is Zakaat Donation, Source, Legal Text, Campaign ID, Campaign Start Date, Jummah ID, Appeal ID, Appeal Name, Donation Form ID, Donation Form Title, Status, Subscribe Mailing List, Stipulation, Fund, Fund Subcat Name, Fund Subcat Code, Donation Form URL, Fundraiser URL, Donation Support Message, Donation Notes, Donor First Name, Donor Last Name, Donor Country, Donor Email, Donor City, Donor Zipcode, Donor Address, Building Number.
Good to know
Your endpoint should respond quickly and handle repeat deliveries safely.
Webhooks provide event-driven data. Use an export for scheduled bulk data. See Export data.