Download OpenAPI specification:Download
This is the private API for Tiltify. It includes endpoints that require specific oauth scopes in order to access. It can be considered as an extension to the public api, but with additional endpoints that may return sensitive information.
Authorization # Please see the public api documentation for additional authorization instructions.
Returns a code
through the applications redirect_uri
to be used with the /token
with the authorization_code
grant.
client_id required | string Client Id |
redirect_uri required | string Redirect URI |
response_type required | string Value: "code" Response Type |
scope | string Default: "public" Enum: "public" "cause" "webhooks:write" Scope |
Returns an access and refresh token with a provided client id, secret, and grant type. Tokens expire in 7200
seconds.
client_id required | string Client Id |
client_secret required | string Client Secret |
grant_type required | string Default: "client_credentials" Enum: "client_credentials" "authorization_code" "refresh_token" Grant Type |
code | string Authorization Code; |
refresh_token | string Refresh Token; |
scope | string Default: "public" Enum: "public" "cause" "webhooks:write" Scope |
{- "access_token": "ab6a592346444dea97170837e104d8a5ab6a592346444dea97170837e104d8a5",
- "created_at": "2023-01-27T19:32:03Z",
- "expires_in": 7200,
- "refresh_token": "njjjytm3otetmgrjmi00yjawlwe4zgytzjixy2mzm2y3njawcg121231999393a3",
- "scope": "public",
- "token_type": "bearer"
}
webhooks:write
This endpoint will activate a given webhook endpoint. Webhook endpoints may be deactivated if they fail to respond sucessfully to our webhooks. This endpoint can be called programatically to ensure that your webhook endpoint is enabled when your listening application starts.
webhook_endpoint_id required | string Webhook Endpoint ID |
{- "activated_at": "2025-09-09T17:20:27.871173Z",
- "deactivated_at": null,
- "description": "My Webhook Endpoint for Tiltify Fundraisers.",
- "id": "9c365c2a-8502-44fc-835e-f2de6663d650",
- "inserted_at": "2025-09-09T17:20:27.871211Z",
- "status": "active",
- "updated_at": "2025-09-09T17:20:27.871215Z",
}
webhooks:write
Deletes a Webhook Subscription to a given webhook_endpoint_id and event_id. This will either delete an existing webhook subscription to the given event or return a null value if the subscription no longer exists.
webhook_endpoint_id required | string Webhook Endpoint ID |
event_id required | string Campaign/Team Campaign/Fundraising Event public_id |
{- "event_id": "51d3edd8-acbb-4818-a64a-4a86596dda41",
- "event_types": [
- "public:direct:donation_updated",
- "public:direct:fact_updated"
], - "id": "daa10209-7a52-4e63-aa7c-32470ae4fdbd",
- "inserted_at": "2025-09-09T18:27:02.645749Z",
- "updated_at": "2025-09-09T18:27:02.645765Z",
- "webhook_endpoint_id": "e704d55c-8a85-431a-9816-2d01292da666"
}
webhooks:write
Creates or Updates a Webhook Subscription to a given webhook_endpoint_id and event_id. This will either update an existing webhook subscription to the given event, or create a new one with the provided event types.
Event types consist of a scope, locality, and event.
The public
scope is always available, and the private
scope is not currently available through the API.
This describes the source of the event, whether direct
to the subscribed event, or indirect
when the event occurs on one of the children of that event. For example all events under a fundraising event, or the campaigns under a team campaign.
This describes the event that is going to be send via webhook. donation_updated
will send donation events, and fact_updated
will send event updates, for example if you need to get the totals raised by a given event.
webhook_endpoint_id required | string Webhook Endpoint ID |
event_id required | string Campaign/Team Campaign/Fundraising Event public_id |
PUT request body to update a webhook subscription
event_types required | Array of strings Items Enum: "private:direct:auction_bid_amount_updated" "private:direct:donation_updated" "private:direct:fact_updated" "private:indirect:donation_updated" "private:indirect:fact_updated" "public:direct:auction_bid_amount_updated" "public:direct:donation_updated" "public:direct:fact_updated" "public:indirect:donation_updated" "public:indirect:fact_updated" The list of event types this subscription should be subscribed to. |
{- "event_types": [
- "public:direct:donation_updated"
]
}
{- "event_id": "51d3edd8-acbb-4818-a64a-4a86596dda41",
- "event_types": [
- "public:direct:donation_updated",
- "public:direct:fact_updated"
], - "id": "daa10209-7a52-4e63-aa7c-32470ae4fdbd",
- "inserted_at": "2025-09-09T18:27:02.645749Z",
- "updated_at": "2025-09-09T18:27:02.645765Z",
- "webhook_endpoint_id": "e704d55c-8a85-431a-9816-2d01292da666"
}
Use putWebhookSubscription instead. This operation was deprecated due to a spelling error.
webhook_endpoint_id required | string Webhook Endpoint ID |
event_id required | string Campaign/Team Campaign/Fundraising Event public_id |
PUT request body to update a webhook subscription
event_types required | Array of strings Items Enum: "private:direct:auction_bid_amount_updated" "private:direct:donation_updated" "private:direct:fact_updated" "private:indirect:donation_updated" "private:indirect:fact_updated" "public:direct:auction_bid_amount_updated" "public:direct:donation_updated" "public:direct:fact_updated" "public:indirect:donation_updated" "public:indirect:fact_updated" The list of event types this subscription should be subscribed to. |
{- "event_types": [
- "public:direct:donation_updated"
]
}
{- "event_id": "51d3edd8-acbb-4818-a64a-4a86596dda41",
- "event_types": [
- "public:direct:donation_updated",
- "public:direct:fact_updated"
], - "id": "daa10209-7a52-4e63-aa7c-32470ae4fdbd",
- "inserted_at": "2025-09-09T18:27:02.645749Z",
- "updated_at": "2025-09-09T18:27:02.645765Z",
- "webhook_endpoint_id": "e704d55c-8a85-431a-9816-2d01292da666"
}
Returns Webhook Relay Keys for a Webhook Relay
webhook_relay_id required | string Webhook Relay ID |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
{- "data": [
- {
- "client_key": "3fee0b7d5aa2ba9727dab0409f9822aa9b6d1914a301ea39ae180750cb632c6a",
- "donation": {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "campaign_id": "80be738a-ab1a-4f8e-8158-a94a251e4d0c",
- "cause_id": "4556c535-1075-4f6d-88b6-068ae548b5e6",
- "completed_at": "2025-09-09T17:20:28.341782Z",
- "donation_matches": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "completed_at": "2025-09-09T17:20:28.367198Z",
- "donation_id": "42378e8c-76b1-475e-af73-a866051fc661",
- "ends_at": "2025-09-09T17:20:28.367193Z",
- "id": "755e075e-6519-4c14-9ad5-44e3e2abc3c9",
- "inserted_at": "2025-09-09T17:20:28.367168Z",
- "matched_by": "Big Donor 1",
- "pledged_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "started_at_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2025-09-09T17:20:28.367189Z",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-09-09T17:20:28.367184Z"
}
], - "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "facts": [
- {
- "id": "deb77044-b760-4425-8579-e720d1e5b3fb",
- "name": "Charity",
- "usage_type": "cause"
}, - {
- "id": "deb77044-b760-4425-8579-e720d1e5b3fb",
- "name": "Massive Fundraiser",
- "usage_type": "fundraising_event_activation"
}, - {
- "id": "deb77044-b760-4425-8579-e720d1e5b3fb",
- "name": "My Campaign",
- "usage_type": "campaign"
}
], - "fundraising_event_id": "09035969-976f-4b8f-a1c9-3b64a5aae226",
- "id": "6861f685-fe81-4ced-bc6c-f9467cb92357",
- "legacy_id": 75730531,
- "payment_status": "completed",
- "poll_id": "8edf334f-3061-4602-ac54-29e60d1b0d89",
- "poll_option_id": "a6d0f034-8d54-44cf-ba91-3296fec85480",
- "reward_claims": [
- {
- "id": "8e6dd22d-e952-48f5-902d-f118ee1f6091",
- "quantity": 1,
- "reward_id": "7d0600e8-b548-400e-bb42-ca666fe92feb"
}
], - "reward_id": "1f366b30-75c9-49c6-b610-6e17b1af1950",
- "sustained": false,
- "target_id": "aa1d64d5-b6f8-4829-93c5-a8c74517c0c6",
- "team_event_id": "cbe7c942-765c-4b96-b7bb-58a872043333"
}, - "id": "ef53632b-7a48-42d2-ad04-d5c1031677d2",
- "inserted_at": "2025-09-09T18:09:05.479939Z",
- "metadata": "Q3VzdG9tIE1ldGFkYXRhIFN0cmluZw==",
- "updated_at": "2025-09-09T18:09:05.482680Z",
- "webhook_relay_id": "c784f8e4-9e2a-4b29-872b-6a0ef31345de"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
webhooks:write
Creates a new Webhook Relay Key.
webhook_relay_id required | string Webhook Relay ID |
POST request body to create a webhook relay key
id | string or null An Optional ID that you can use to lookup the Relay Key. If you do not pass one, we will generate an UUID for you. |
metadata | string or null An Optional string of metadata that will be associated with the relay key. Metadata will be stored, and sent to your webhook endpoint as is. |
{- "id": "internal_2Oycg8ksnPDz9ku2RhDuVuvEfmV",
- "metadata": "Q3VzdG9tIE1ldGFkYXRhIFN0cmluZw=="
}
{- "client_key": "3fee0b7d5aa2ba9727dab0409f9822aa9b6d1914a301ea39ae180750cb632c6a",
- "donation": {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "campaign_id": "80be738a-ab1a-4f8e-8158-a94a251e4d0c",
- "cause_id": "4556c535-1075-4f6d-88b6-068ae548b5e6",
- "completed_at": "2025-09-09T17:20:28.341782Z",
- "donation_matches": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "completed_at": "2025-09-09T17:20:28.367198Z",
- "donation_id": "42378e8c-76b1-475e-af73-a866051fc661",
- "ends_at": "2025-09-09T17:20:28.367193Z",
- "id": "755e075e-6519-4c14-9ad5-44e3e2abc3c9",
- "inserted_at": "2025-09-09T17:20:28.367168Z",
- "matched_by": "Big Donor 1",
- "pledged_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "started_at_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2025-09-09T17:20:28.367189Z",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-09-09T17:20:28.367184Z"
}
], - "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "facts": [
- {
- "id": "deb77044-b760-4425-8579-e720d1e5b3fb",
- "name": "Charity",
- "usage_type": "cause"
}, - {
- "id": "deb77044-b760-4425-8579-e720d1e5b3fb",
- "name": "Massive Fundraiser",
- "usage_type": "fundraising_event_activation"
}, - {
- "id": "deb77044-b760-4425-8579-e720d1e5b3fb",
- "name": "My Campaign",
- "usage_type": "campaign"
}
], - "fundraising_event_id": "09035969-976f-4b8f-a1c9-3b64a5aae226",
- "id": "6861f685-fe81-4ced-bc6c-f9467cb92357",
- "legacy_id": 75730531,
- "payment_status": "completed",
- "poll_id": "8edf334f-3061-4602-ac54-29e60d1b0d89",
- "poll_option_id": "a6d0f034-8d54-44cf-ba91-3296fec85480",
- "reward_claims": [
- {
- "id": "8e6dd22d-e952-48f5-902d-f118ee1f6091",
- "quantity": 1,
- "reward_id": "7d0600e8-b548-400e-bb42-ca666fe92feb"
}
], - "reward_id": "1f366b30-75c9-49c6-b610-6e17b1af1950",
- "sustained": false,
- "target_id": "aa1d64d5-b6f8-4829-93c5-a8c74517c0c6",
- "team_event_id": "cbe7c942-765c-4b96-b7bb-58a872043333"
}, - "id": "ef53632b-7a48-42d2-ad04-d5c1031677d2",
- "inserted_at": "2025-09-09T18:09:05.479939Z",
- "metadata": "Q3VzdG9tIE1ldGFkYXRhIFN0cmluZw==",
- "updated_at": "2025-09-09T18:09:05.482680Z",
- "webhook_relay_id": "c784f8e4-9e2a-4b29-872b-6a0ef31345de"
}
Returns a Webhook Relay Key by its ID
webhook_relay_id required | string Webhook Relay ID |
webhook_relay_key_id required | string Webhook Relay Key ID |
{- "data": {
- "client_key": "3fee0b7d5aa2ba9727dab0409f9822aa9b6d1914a301ea39ae180750cb632c6a",
- "donation": {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "campaign_id": "80be738a-ab1a-4f8e-8158-a94a251e4d0c",
- "cause_id": "4556c535-1075-4f6d-88b6-068ae548b5e6",
- "completed_at": "2025-09-09T17:20:28.341782Z",
- "donation_matches": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "completed_at": "2025-09-09T17:20:28.367198Z",
- "donation_id": "42378e8c-76b1-475e-af73-a866051fc661",
- "ends_at": "2025-09-09T17:20:28.367193Z",
- "id": "755e075e-6519-4c14-9ad5-44e3e2abc3c9",
- "inserted_at": "2025-09-09T17:20:28.367168Z",
- "matched_by": "Big Donor 1",
- "pledged_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "started_at_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2025-09-09T17:20:28.367189Z",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-09-09T17:20:28.367184Z"
}
], - "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "facts": [
- {
- "id": "deb77044-b760-4425-8579-e720d1e5b3fb",
- "name": "Charity",
- "usage_type": "cause"
}, - {
- "id": "deb77044-b760-4425-8579-e720d1e5b3fb",
- "name": "Massive Fundraiser",
- "usage_type": "fundraising_event_activation"
}, - {
- "id": "deb77044-b760-4425-8579-e720d1e5b3fb",
- "name": "My Campaign",
- "usage_type": "campaign"
}
], - "fundraising_event_id": "09035969-976f-4b8f-a1c9-3b64a5aae226",
- "id": "6861f685-fe81-4ced-bc6c-f9467cb92357",
- "legacy_id": 75730531,
- "payment_status": "completed",
- "poll_id": "8edf334f-3061-4602-ac54-29e60d1b0d89",
- "poll_option_id": "a6d0f034-8d54-44cf-ba91-3296fec85480",
- "reward_claims": [
- {
- "id": "8e6dd22d-e952-48f5-902d-f118ee1f6091",
- "quantity": 1,
- "reward_id": "7d0600e8-b548-400e-bb42-ca666fe92feb"
}
], - "reward_id": "1f366b30-75c9-49c6-b610-6e17b1af1950",
- "sustained": false,
- "target_id": "aa1d64d5-b6f8-4829-93c5-a8c74517c0c6",
- "team_event_id": "cbe7c942-765c-4b96-b7bb-58a872043333"
}, - "id": "ef53632b-7a48-42d2-ad04-d5c1031677d2",
- "inserted_at": "2025-09-09T18:09:05.479939Z",
- "metadata": "Q3VzdG9tIE1ldGFkYXRhIFN0cmluZw==",
- "updated_at": "2025-09-09T18:09:05.482680Z",
- "webhook_relay_id": "c784f8e4-9e2a-4b29-872b-6a0ef31345de"
}
}