Skip to main content
API docs by Redocly

V5ApiPrivate (1.0)

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

Authorization # Please see the public api documentation for additional authorization instructions.

OAuth

OAuth 2.0 endpoints

Authorize

Returns a code through the applications redirect_uri to be used with the /token with the authorization_code grant.

Authorizations:
authorization
query Parameters
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

Token

Returns an access and refresh token with a provided client id, secret, and grant type. Tokens expire in 7200 seconds.

Authorizations:
authorization
query Parameters
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; *required if using authorization_code grant type

refresh_token
string

Refresh Token; *required if using refresh_token grant type

scope
string
Default: "public"
Enum: "public" "cause" "webhooks:write"

Scope

Responses

Response samples

Content type
application/json
{
  • "access_token": "ab6a592346444dea97170837e104d8a5ab6a592346444dea97170837e104d8a5",
  • "created_at": "2023-01-27T19:32:03Z",
  • "expires_in": 7200,
  • "refresh_token": "njjjytm3otetmgrjmi00yjawlwe4zgytzjixy2mzm2y3njawcg121231999393a3",
  • "scope": "public",
  • "token_type": "bearer"
}

Webhook

Webhook endpoints

Activates a webhook endpoint

Requires scope: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.

Authorizations:
authorization
path Parameters
webhook_endpoint_id
required
string

Webhook Endpoint ID

Responses

Response samples

Content type
application/json
{
  • "activated_at": "2024-01-02T17:56:40.063463Z",
  • "deactivated_at": null,
  • "description": "My Webhook Endpoint for Tiltify Fundraisers.",
  • "id": "e46168dd-7c19-4eae-900a-a8d8cf84c1c6",
  • "inserted_at": "2024-01-02T17:56:40.063506Z",
  • "status": "active",
  • "updated_at": "2024-01-02T17:56:40.063511Z",
  • "url": "https://webhooks.tiltify.test/endpoint"
}

Deletes a Webhook Subscription

Requires scope: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.

Authorizations:
authorization
path Parameters
webhook_endpoint_id
required
string

Webhook Endpoint ID

event_id
required
string

Campaign/Team Campaign/Fundraising Event public_id

Responses

Response samples

Content type
application/json
{
  • "event_id": "421fc84c-52ab-49d6-b1e9-66c29a3693b5",
  • "event_types": [
    ],
  • "id": "18e35562-1994-4333-b84e-c682e0afc57e",
  • "inserted_at": "2024-04-05T21:00:42.672819Z",
  • "updated_at": "2024-04-05T21:00:42.672830Z",
  • "webhook_endpoint_id": "2b03eb79-1cbe-423d-97eb-b20b0ae253f0"
}

Creates or Updates a Webhook Subscription

Requires scope: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

Event types consist of a scope, locality, and event.

Scope

The public scope is always available, and the private scope is not currently available through the API.

Locality

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.

Event

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.

List of supported event_types:

  • public:direct:donation_updated
  • public:direct:fact_updated
  • public:indirect:donation_updated
  • public:indirect:fact_updated
Authorizations:
authorization
path Parameters
webhook_endpoint_id
required
string

Webhook Endpoint ID

event_id
required
string

Campaign/Team Campaign/Fundraising Event public_id

Request Body schema: application/json
optional

PUT request body to update a webhook subscription

event_types
required
Array of strings
Items Enum: "private:direct:donation_updated" "private:direct:fact_updated" "private:indirect:donation_updated" "private:indirect:fact_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.

Responses

Request samples

Content type
application/json
{
  • "event_types": [
    ]
}

Response samples

Content type
application/json
{
  • "event_id": "421fc84c-52ab-49d6-b1e9-66c29a3693b5",
  • "event_types": [
    ],
  • "id": "18e35562-1994-4333-b84e-c682e0afc57e",
  • "inserted_at": "2024-04-05T21:00:42.672819Z",
  • "updated_at": "2024-04-05T21:00:42.672830Z",
  • "webhook_endpoint_id": "2b03eb79-1cbe-423d-97eb-b20b0ae253f0"
}

Creates or Updates a Webhook Subscription Deprecated

Use putWebhookSubscription instead. This operation was deprecated due to a spelling error.

Authorizations:
authorization
path Parameters
webhook_endpoint_id
required
string

Webhook Endpoint ID

event_id
required
string

Campaign/Team Campaign/Fundraising Event public_id

Request Body schema: application/json
optional

PUT request body to update a webhook subscription

event_types
required
Array of strings
Items Enum: "private:direct:donation_updated" "private:direct:fact_updated" "private:indirect:donation_updated" "private:indirect:fact_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.

Responses

Request samples

Content type
application/json
{
  • "event_types": [
    ]
}

Response samples

Content type
application/json
{
  • "event_id": "421fc84c-52ab-49d6-b1e9-66c29a3693b5",
  • "event_types": [
    ],
  • "id": "18e35562-1994-4333-b84e-c682e0afc57e",
  • "inserted_at": "2024-04-05T21:00:42.672819Z",
  • "updated_at": "2024-04-05T21:00:42.672830Z",
  • "webhook_endpoint_id": "2b03eb79-1cbe-423d-97eb-b20b0ae253f0"
}

List Relay Keys by Webhook Relay ID

Returns Webhook Relay Keys for a Webhook Relay

Authorizations:
authorization
path Parameters
webhook_relay_id
required
string

Webhook Relay ID

query Parameters
after
string

Returns records after the given cursor

before
string

Returns records before the given cursor

limit
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Creates a new Webhook Relay Key

Requires scope:webhooks:write

Creates a new Webhook Relay Key.

Authorizations:
authorization
path Parameters
webhook_relay_id
required
string

Webhook Relay ID

Request Body schema: application/json
optional

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.

Responses

Request samples

Content type
application/json
{
  • "id": "internal_2Oycg8ksnPDz9ku2RhDuVuvEfmV",
  • "metadata": "Q3VzdG9tIE1ldGFkYXRhIFN0cmluZw=="
}

Response samples

Content type
application/json
{
  • "client_key": "f90a65c39d7e067f48abe96029e0354654159ff75ae2e2b63a0ee3bf23e7db7d",
  • "donation": {
    },
  • "id": "84aae196-1ac3-4d13-a92c-444d95870843",
  • "inserted_at": "2024-04-05T21:00:42.671365Z",
  • "metadata": "Q3VzdG9tIE1ldGFkYXRhIFN0cmluZw==",
  • "updated_at": "2024-04-05T21:00:42.671383Z",
  • "webhook_relay_id": "eeaee35b-079b-4879-a080-6fdf35778342"
}

Returns a Webhook Relay Key by ID

Returns a Webhook Relay Key by its ID

Authorizations:
authorization
path Parameters
webhook_relay_id
required
string

Webhook Relay ID

webhook_relay_key_id
required
string

Webhook Relay Key ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}