Event payloads

CrowdChange sends webhook deliveries as JSON with an event name and event-specific data. The same object is stored on webhook logs as payload.

{
  "event": "transaction_created",
  "data": {}
}

Updated event changes

The fundraiser_updated, fundraiser_team_updated, and fundraiser_page_updated events include a changes object in data.

object

Changed fields keyed by dot notation. Each changed field contains old and new values.

{
  "changes": {
    "name": {
      "old": "Old campaign name",
      "new": "New campaign name"
    }
  }
}

Campaign events

Events: fundraiser_created, fundraiser_updated

object

Campaign details.

Show properties

integer

Campaign ID.

integer

Partner ID.

string

Campaign name.

string

Campaign description.

string

Campaign URL.

number

Campaign goal amount.

number

Campaign raised amount.

number

Pending offline donation amount.

number

Campaign matched donation amount.

integer

Number of donors.

string

Campaign start date and time.

string

Campaign end date and time.

string

Campaign language.

array

Campaign tags.

string

Campaign creation date and time.

object

Campaign owner.

object | null

Campaign template summary, when applicable.

object

Included on fundraiser_updated events.

Transaction events

Events: transaction_created

object

Transaction details.

Show properties

integer

Transaction ID.

string

Transaction reference ID.

number

Transaction total amount.

string

Transaction currency.

string

Transaction currency symbol.

string

Donation frequency.

integer

Campaign ID.

integer | null

Parent transaction ID, when applicable.

integer | null

Personal page ID, when applicable.

integer | null

Team ID, when applicable.

integer | null

Organization ID, when applicable.

string

Campaign name.

string | null

Organization name, when applicable.

string | null

Organization custom ID, when applicable.

integer

Donor user ID.

string

Donor email.

object | null

Mailing address when a receipt is mailed.

string | null

Payment statement descriptor.

object

Transaction amount breakdown.

object | null

Upsell details, when applicable.

Applied promo code, when applicable.

object | null

Billing address.

object | null

Dedication or tribute data, when applicable.

string

Transaction creation date and time.

string

Transaction status.

object[]

Assigned tickets, when applicable.

Team events

Events: fundraiser_team_created, fundraiser_team_updated

object

Team details.

Show properties

integer

Team ID.

string

Team name.

string

Team URL.

number

Team goal amount.

number

Team raised amount.

number

Pending offline donation amount for the team.

number

Team matched donation amount.

integer

Number of team donors.

integer

Number of personal pages on the team.

string

Team creation date and time.

string

Team language.

object

Custom team field data.

object

Team owner.

object

Campaign summary.

object

Included on fundraiser_team_updated events.

Personal page events

Events: fundraiser_page_created, fundraiser_page_updated

object

Personal page details.

Show properties

integer

Personal page ID.

string

Personal page name.

string

Personal page URL.

number

Personal page goal amount.

number

Personal page raised amount.

number

Pending offline donation amount for the personal page.

number

Personal page matched donation amount.

integer

Number of personal page donors.

string

Personal page creation date and time.

string

Personal page language.

object

Custom personal page field data.

object

Personal page owner.

object

Campaign summary.

object | null

Team summary, when the page belongs to a team.

object

Included on fundraiser_page_updated events.

Tax receipt events

Events: tax_receipt_issued

object

Tax receipt details.

Show properties

integer

Tax receipt ID.

integer

Transaction ID.

number

Donation amount.

number

Benefit amount.

number

Tax-eligible amount.

string | null

Business name, when applicable.

string

Name printed on the receipt.

string

Receipt issue date and time.

string

Receipt number.

string

Receipt status. Values are valid or cancelled.

string

Recipient first name.

string

Recipient last name.

string | null

Recipient title.

string

Recipient email.

string

Recipient street address.

string

Recipient state or province.

string

Recipient country.

string

Recipient postal code.

string

Recipient city.

Milestone events

Events: milestone_triggered Sent when a milestone notification is triggered for the original recipient. Additional recipient emails configured on the milestone are not included in the webhook payload.

object

Milestone details.

Show properties

integer

Milestone log ID.

integer

Mail template ID.

string

Mail template name.

string

Mail template type.

string

Milestone trigger identifier.

string

Trigger recipient group.

string

Trigger value type, such as amount or percent.

string

Configured milestone trigger value.

object

Additional trigger data. Additional recipient emails are excluded.

string

Date and time the notification was queued.

object

Original milestone recipient.

object

Campaign summary.

object | null

Team that reached the milestone, when applicable.

object | null

Personal page that reached the milestone, when applicable.

Introduction

Server Side APIs

Client Side APIs

Updated event changes

Campaign events

Transaction events

Team events

Personal page events

Tax receipt events

Milestone events

​Updated event changes

​Campaign events

​Transaction events

​Team events

​Personal page events

​Tax receipt events

​Milestone events

Updated event changes

Campaign events

Transaction events

Team events

Personal page events

Tax receipt events

Milestone events