Reconciliation
We provide a few endpoints that can be used for reconciliation purposes. These endpoints allow you to look up the current state of a given Webhook Relay Key. Note, that we do send webhook events for every completed and cancellation event, so you shouldn't need to use these endpoints.
To use these endpoints, you will need either the webhooks:read or
webhooks:write scope, as well as the Webhook Relay ID found in your Developer
Dashboard.
Get Relay Key
This endpoint returns a single Relay Key by the ID. This ID is either the ID passed or the autogenerated UUID that is returned when generating a new Relay Key.
For more information on this endpoint, see the Api Reference.
- cURL
curl -X GET https://v5api.tiltify.com/api/private/webhook_relays/8e615ce4-9246-42d3-b3b2-b3fba2b55d2a/webhook_relay_keys/4feff944-a745-41cd-94c3-e390b213d797 \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer ab6a592346444dea97170837e104d8a5ab6a592346444dea97170837e104d8a5'
If everything goes well, you should receive a successful response that looks like:
{
"data": {
"client_key": "1327f5f2eec1931a4ca25fa9d1b44f3bd50f97e77a5c67bc2c7bc55096f6cf11",
"donation": {
"amount": {"currency": "USD", "value": "1.0"},
"campaign_id": null,
"cause_id": "a42c292d-e692-4b2c-8650-540fe72af060",
"completed_at": "2023-05-17T20:03:20.920890Z",
"created_at": "2023-05-17T20:03:20Z",
"donation_matches": null,
"donor_comment": "Always in motion is the future.",
"donor_name": "Anonymous",
"fundraising_event_id": null,
"id": "d94b11ff-abbf-42ae-97a3-3e02f94d0a29",
"is_match": false,
"legacy_id": 1,
"payment_status": "completed",
"poll_id": null,
"poll_option_id": null,
"reward_id": null,
"sustained": false,
"target_id": null,
"team_event_id": null
},
"id": "e8f97724-ac23-4b43-ba38-5d6c375a6d3c",
"inserted_at": "2023-05-17T20:03:20.926920Z",
"metadata": null,
"updated_at": "2023-05-17T20:03:20.926920Z",
"webhook_relay_id": "2b419145-0f75-4fef-89bb-566fbd81257a"
}
}
List Relay Keys
This endpoint returns all Relay Keys under a given Relay. You can paginated through them all to get the current payment status of all relayed Donations.
For more information on this endpoint, see the Api Reference.
- cURL
curl -X GET https://v5api.tiltify.com/api/private/webhook_relays/4a3dba30-8d7a-4e91-bfd1-684c6dc84d1e/webhook_relay_keys \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer ab6a592346444dea97170837e104d8a5ab6a592346444dea97170837e104d8a5'
If everything goes well, you should receive a successful response that looks like:
{
"data": [
{
"client_key": "b88f8e2415a13964f02c3a40897d75bfb883256e9b389ded6f59f85b81ab7a9d",
"donation": {
"amount": {"currency": "USD", "value": "10.00"},
"campaign_id": null,
"cause_id": "dd5f83dc-5896-4423-ace5-230d3fef5f2c",
"completed_at": "2023-05-17T19:58:12.436520Z",
"created_at": "2023-05-17T19:58:12Z",
"donation_matches": null,
"donor_comment": "Among the children of the Jedi, there are no innocents.",
"donor_name": "Anonymous",
"fundraising_event_id": null,
"id": "b4cb72c4-db23-46c9-8805-474feee075ef",
"is_match": false,
"legacy_id": 41,
"payment_status": "completed",
"poll_id": null,
"poll_option_id": null,
"reward_id": null,
"sustained": false,
"target_id": null,
"team_event_id": null
},
"id": "9284c13b-1e0f-4489-9645-8c1a915b5c26",
"inserted_at": "2023-05-17T19:43:46.377317Z",
"metadata": null,
"updated_at": "2023-05-17T19:43:46.377317Z",
"webhook_relay_id": "4a3dba30-8d7a-4e91-bfd1-684c6dc84d1e"
},
{
"client_key": "67345f69213f9a55679b4a875d40dc367cfa696906a7a5817362c559b95911a6",
"donation": null,
"id": "91eca53e-3210-4442-8232-ab0514a72c0e",
"inserted_at": "2023-05-17T19:43:46.376557Z",
"metadata": null,
"updated_at": "2023-05-17T19:43:46.376557Z",
"webhook_relay_id": "4a3dba30-8d7a-4e91-bfd1-684c6dc84d1e"
},
{
"client_key": "d112be1fe7417e05864e7acddd70115e0879d151e398b709dc6ed1ea0044f9a9",
"donation": null,
"id": "7061b252-b5d4-40b2-8f1f-aeb3aa67a07f",
"inserted_at": "2023-05-17T19:43:46.375806Z",
"metadata": null,
"updated_at": "2023-05-17T19:43:46.375806Z",
"webhook_relay_id": "4a3dba30-8d7a-4e91-bfd1-684c6dc84d1e"
},
{
"client_key": "0b9b19f3c8ffa83e108ec2b03aa2bf42f82e03b55399467714c19d5bf21d080f",
"donation": {
"amount": {"currency": "USD", "value": "20.00"},
"campaign_id": null,
"cause_id": "f2d5cc23-87af-47b5-bcea-b5aabbcd0345",
"completed_at": "2023-05-17T19:58:12.438583Z",
"created_at": "2023-05-17T19:58:12Z",
"donation_matches": null,
"donor_comment": "There's always a bigger fish.",
"donor_name": "Anonymous",
"fundraising_event_id": null,
"id": "dfa3aa77-238a-46fd-b443-b0e90da10eb9",
"is_match": false,
"legacy_id": 42,
"payment_status": "cancelled",
"poll_id": null,
"poll_option_id": null,
"reward_id": null,
"sustained": false,
"target_id": null,
"team_event_id": null
},
"id": "1854ffbc-2a8b-445f-8dbe-7766155d15ea",
"inserted_at": "2023-05-17T19:43:46.375025Z",
"metadata": null,
"updated_at": "2023-05-17T19:43:46.375025Z",
"webhook_relay_id": "4a3dba30-8d7a-4e91-bfd1-684c6dc84d1e"
},
{
"client_key": "0690479c76cfde0e02e545326bf84fbb5b03e6638734116b95c3a929cc86988e",
"donation": null,
"id": "6f1aceac-c3a8-457c-bac0-03899e311678",
"inserted_at": "2023-05-17T19:43:46.374274Z",
"metadata": null,
"updated_at": "2023-05-17T19:43:46.374274Z",
"webhook_relay_id": "4a3dba30-8d7a-4e91-bfd1-684c6dc84d1e"
},
{
"client_key": "e6d57170f9653b1c46e867f39394e8296ae816f47db38e7342c3f129ed75c817",
"donation": null,
"id": "2da0eea1-1635-4777-818b-cdd6bce6d7ef",
"inserted_at": "2023-05-17T19:43:46.373536Z",
"metadata": null,
"updated_at": "2023-05-17T19:43:46.373536Z",
"webhook_relay_id": "4a3dba30-8d7a-4e91-bfd1-684c6dc84d1e"
},
{
"client_key": "e4d1b14cc7326c3c836ab34d8d173d80af28efb2b8dde148f0a9dca22682becb",
"donation": {
"amount": {"currency": "USD", "value": "1.00"},
"campaign_id": null,
"cause_id": "bbc25445-2d57-44a8-b960-75b6ad9ad32c",
"completed_at": "2023-05-17T19:58:12.449507Z",
"created_at": "2023-05-17T19:58:12Z",
"donation_matches": null,
"donor_comment": "Will someone get this big walking carpet out of my way?",
"donor_name": "Anonymous",
"fundraising_event_id": null,
"id": "335a11b9-b002-420d-81c4-c853cfcb6f52",
"is_match": false,
"legacy_id": 47,
"payment_status": "pending",
"poll_id": null,
"poll_option_id": null,
"reward_id": null,
"sustained": false,
"target_id": null,
"team_event_id": null
},
"id": "a5385b70-547f-411e-bdc5-8fc57e7618e8",
"inserted_at": "2023-05-17T19:43:46.372755Z",
"metadata": null,
"updated_at": "2023-05-17T19:43:46.372755Z",
"webhook_relay_id": "4a3dba30-8d7a-4e91-bfd1-684c6dc84d1e"
},
{
"client_key": "7ac9b45d838e15d55cd96b1863336b662e228a7f45308a0447b00f444dd49b85",
"donation": null,
"id": "7ddf150a-152b-4c01-b2b2-677ba0abf24a",
"inserted_at": "2023-05-17T19:43:46.371996Z",
"metadata": null,
"updated_at": "2023-05-17T19:43:46.371996Z",
"webhook_relay_id": "4a3dba30-8d7a-4e91-bfd1-684c6dc84d1e"
},
{
"client_key": "74ab53bc4ac1bf481e491f0ee21bc22a40aaaa47006a492474aaebd4bb75dbec",
"donation": null,
"id": "87f7c1b3-e0e9-4758-8780-bda2eb6f645e",
"inserted_at": "2023-05-17T19:43:46.371232Z",
"metadata": null,
"updated_at": "2023-05-17T19:43:46.371232Z",
"webhook_relay_id": "4a3dba30-8d7a-4e91-bfd1-684c6dc84d1e"
},
{
"client_key": "82067d41703bf084309a396c7e02461d72e5c5808b50795c95752d617e66fe65",
"donation": null,
"id": "d98d9069-6b32-4198-a472-2a3bd4f56cd7",
"inserted_at": "2023-05-17T19:43:46.370503Z",
"metadata": null,
"updated_at": "2023-05-17T19:43:46.370503Z",
"webhook_relay_id": "4a3dba30-8d7a-4e91-bfd1-684c6dc84d1e"
}
],
"metadata": {
"after": "g2wAAAABdAAAAA1kAApfX3N0cnVjdF9fZAAPRWxpeGlyLkRhdGVUaW1lZAAIY2FsZW5kYXJkABNFbGl4aXIuQ2FsZW5kYXIuSVNPZAADZGF5YRFkAARob3VyYRNkAAttaWNyb3NlY29uZGgCYgAFp0dhBmQABm1pbnV0ZWErZAAFbW9udGhhBWQABnNlY29uZGEuZAAKc3RkX29mZnNldGEAZAAJdGltZV96b25lbQAAAAdFdGMvVVRDZAAKdXRjX29mZnNldGEAZAAEeWVhcmIAAAfnZAAJem9uZV9hYmJybQAAAANVVENq",
"before": null,
"limit": 10
}
}