Skip to main content

Webhook

Voucher used

This trigger is sent everytime that a voucher is used, generally used to identify which and when a user uses a voucher.

ParamInfoExample
idVoucher id1
external_idExternal voucher identifier5e4dca12df7eb4f16ace41e9c9ded372
callback_urlUrl to check the transactionhttps://ribon.io/integrations/v1/vouchers/5e4dca12df7eb4f16ace41e9c9ded372
donation.idDonation id10
donation.impactDonation's impact1 hour(s) of consult
donation.impact_valueUnit of impacts1
donation.non_profit.nameNon profit nameEvidence Action
donation.non_profit.background_imageNon profit image urlhttps://ribon.io/nonprofit-url
donation.non_profit.impact_by_ticketNumber of impact units per voucher1
donation.non_profit.impact_descriptionDescription of impact unithour(s) of consult
donation.non_profit.cause.nameCause nameHealth
donation.user.emailUser emailuser@example.com
donation.donation_blockchain_transaction.chain_idChain id137
donation.donation_blockchain_transaction.statusTransaction statussuccess
donation.donation_blockchain_transaction.transaction_hashTransaction hash0x95700345291ac525c1291bdea6ddc44f08525979a17c07017cb928522a41a063

Response example

{
"id": 1,
"external_id": "5e4dca12df7eb4f16ace41e9c9ded372",
"callback_url": "http://ribon-core-api-dev.us-east-1.elasticbeanstalk.com/integrations/v1/vouchers/external",
"donation": {
"id": 275,
"impact": "1 hour(s) of consult",
"impact_value": 1,
"non_profit": {
"id": 2,
"name": "Time to live",
"background_image": "http://ribon-core-api-dev.us-east-1.elasticbeanstalk.com//rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBHUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--20cef27a2b7fe19188bf2f2598d0fe9ac75e05c6/post_donation.png",
"impact_by_ticket": 1,
"impact_description": "hour(s) of consult",
"logo": "http://ribon-core-api-dev.us-east-1.elasticbeanstalk.com//rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBGdz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--f804ee6fef7678025f9a2445507edf6f9c6f8074/logo.png",
"main_image": "http://ribon-core-api-dev.us-east-1.elasticbeanstalk.com//rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBHQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--129ce94150043f3d29c10282f17a12a391db0905/card.png",
"wallet_address": "0x6E060041D62fDd76cF27c582f62983b864878E8F",
"cause": {
"id": 2,
"name": "Health "
},
"created_at": "2022-08-08 10:24:15 -0300",
"updated_at": "2022-09-28 11:48:20 -0300",
},
"user": {
"id": 17,
"email": "user@example.com",
"created_at": "2022-08-10 13:33:11 -0300",
"updated_at": "2022-08-10 13:33:11 -0300"
},
"donation_blockchain_transaction": {
"id": 206,
"chain_id": 1,
"status": "success",
"transaction_hash": "0x95700345291ac525c1291bdea6ddc44f08525979a17c07017cb928522a41a063",
"created_at": "2022-09-30 08:33:15 -0300",
"updated_at": "2022-09-30 08:38:21 -0300"
},
"created_at": "2022-09-30 08:33:14 -0300",
"updated_at": "2022-09-30 08:33:14 -0300"
},
"created_at": "2022-09-30 08:33:14 -0300",
"updated_at": "2022-09-30 08:33:14 -0300"
}