Donate

Notifies when a Donation of a Creator Coin event happens.

A Donation is distinct from a Transfer in that a Donation is specifically defined as a transfer of a specific Creator's Creator Coin to that Creator. i.e. a transfer of ALLIE coin to Alliestrasza is a Donation. A transfer of any other type of Creator Coin to Alliestrasza is designated as a regular Transfer, not a Donation. .

Note: on the Rally.io website, Donations are now labeled as Sends, however in the API they are still labeled as Donations to make the events distinct.

Example Event payload for a non creator approved webhook. Notice that the fromUsername is null because in this case the user has chosen to NOT make their username public.

{
"event":"DONATE",
"coinKind":"BEE",
"data":
{
"transactionId":"5ec31129-f5e6-4c25-9188-9a0401183d3d",
"fromUsername":"null",
"amountOfCoin":12,
"costInUSCents":2097,
"createdDate":"2021-02-09T10:09:00.133Z",
"completedDate":"2021-02-09T10:09:10.645Z"
}
}

Example Event payload for a creator approved webhook for the same event as above. Notice how the fromUsername is now shown along with the showUsername flag indicating the user chose to make their username NOT public. If the application is only going to be seen and used by the creator themselves, it is permissible to display the fromUsername in the app. If the application will be seen by the public, it must respect the showUsername flag and hide/display the username accordingly.

{
"event":"DONATE",
"coinKind":"BEE",
"data":
{
"transactionId":"5ec31129-f5e6-4c25-9188-9a0401183d3d",
"fromUsername":"iamausername",
"amountOfCoin":12,
"costInUSCents":2097,
"createdDate":"2021-02-09T10:09:00.133Z",
"completedDate":"2021-02-09T10:09:10.645Z",
"fromUserId":"58b314f4-cc51-11ea-8bc5-72318caf4d1a",
"toUserId":"3263f542-5b43-11eb-8b6c-22621c519feb",
"showUsername":false,
"memo":"I really enjoy your content! keep it up!",
"showMemo":true,
"referenceData": "some custom data"
}
}