Givebutter
givebutterGivebutter is a fundraising platform that offers a free, open, and public API for developers to manage campaigns, track donations, and engage with supporters.
Acciones disponibles (18)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Archive ContactGIVEBUTTER_ARCHIVE_CONTACTAcciónTool to archive a contact by their id. use after ensuring the contact has no associated data (e.g., no transactions or communications). example: "archive contact abc123".
GIVEBUTTER_ARCHIVE_CONTACTAcciónTool to archive a contact by their id. use after ensuring the contact has no associated data (e.g., no transactions or communications). example: "archive contact abc123".
Parámetros de entrada
contact_idstringObligatorioUnique identifier of the contact to archive. The contact must have no associated data like transactions, recurring donations, auction bids, tickets, or communications.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create CampaignGIVEBUTTER_CREATE_CAMPAIGNAcciónTool to create a new campaign. use when you have title, description, goal, and type ready, after confirming your givebutter account is authenticated.
GIVEBUTTER_CREATE_CAMPAIGNAcciónTool to create a new campaign. use when you have title, description, goal, and type ready, after confirming your givebutter account is authenticated.
Parámetros de entrada
goalintegerCampaign goal amount in cents (e.g., $1000 -> 100000).
metaobjectSEO meta tags for the campaign page.
slugstringUnique slug for the campaign; auto-generated if omitted.
typestringObligatorioenumType of the campaign.
generalcollectfundraiseeventcoverobjectBanner image settings; include only when providing a cover.
titlestringObligatorioPrimary title of the campaign.
end_atstringUTC datetime string when the campaign ends.
currencystringCurrency code; only USD is currently supported.
subtitlestringOptional subtitle displayed under the title.
descriptionstringHTML content for the campaign description.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create WebhookGIVEBUTTER_CREATE_WEBHOOKAcciónTool to create a new webhook subscription. use when you need to receive real-time notifications programmatically after confirming your endpoint can validate givebutter's signing secret.
GIVEBUTTER_CREATE_WEBHOOKAcciónTool to create a new webhook subscription. use when you need to receive real-time notifications programmatically after confirming your endpoint can validate givebutter's signing secret.
Parámetros de entrada
urlstringObligatorioThe HTTPS endpoint URL that will receive webhook payloads.
namestringObligatorioA friendly name for the webhook subscription.
eventsstring[]ObligatorioList of event types that will trigger this webhook subscription.
enabledbooleanWhether the webhook is active immediately upon creation.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete CampaignGIVEBUTTER_DELETE_CAMPAIGNAcciónTool to delete a campaign by its id. use after confirming the campaign has no funds raised. example: "delete campaign abc123".
GIVEBUTTER_DELETE_CAMPAIGNAcciónTool to delete a campaign by its id. use after confirming the campaign has no funds raised. example: "delete campaign abc123".
Parámetros de entrada
campaign_idstringObligatorioUnique identifier of the campaign to delete. Cannot delete if the campaign has any funds raised.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ContactGIVEBUTTER_DELETE_CONTACTAcciónTool to delete a contact by their id. use after confirming the contact has no associated data (e.g., no transactions or communications). example: "delete contact abc123".
GIVEBUTTER_DELETE_CONTACTAcciónTool to delete a contact by their id. use after confirming the contact has no associated data (e.g., no transactions or communications). example: "delete contact abc123".
Parámetros de entrada
contact_idstringObligatorioUnique identifier of the contact to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete FundGIVEBUTTER_DELETE_FUNDAcciónTool to delete a fund by its id. use when you need to remove a fund after confirming it exists. example: "delete fund fund abc123".
GIVEBUTTER_DELETE_FUNDAcciónTool to delete a fund by its id. use when you need to remove a fund after confirming it exists. example: "delete fund fund abc123".
Parámetros de entrada
fund_idstringObligatorioUnique identifier of the fund to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete WebhookGIVEBUTTER_DELETE_WEBHOOKAcciónTool to delete a webhook by its id. use when you need to remove an obsolete webhook after confirming no further events are needed. example: "delete webhook abc123".
GIVEBUTTER_DELETE_WEBHOOKAcciónTool to delete a webhook by its id. use when you need to remove an obsolete webhook after confirming no further events are needed. example: "delete webhook abc123".
Parámetros de entrada
webhook_idstringObligatorioUnique identifier of the webhook to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get FundGIVEBUTTER_GET_FUNDAcciónTool to retrieve details of a specific fund by its id. use after confirming the fund id is valid.
GIVEBUTTER_GET_FUNDAcciónTool to retrieve details of a specific fund by its id. use after confirming the fund id is valid.
Parámetros de entrada
fund_idstringObligatorioUnique identifier of the fund to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get MembersGIVEBUTTER_GET_MEMBERSAcciónTool to retrieve a paginated list of members for a given campaign. use when you need to list or process campaign members.
GIVEBUTTER_GET_MEMBERSAcciónTool to retrieve a paginated list of members for a given campaign. use when you need to list or process campaign members.
Parámetros de entrada
pageintegerPage number for pagination, must be >= 1
campaign_idstringObligatorioUnique identifier of the campaign to retrieve members from
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get PayoutsGIVEBUTTER_GET_PAYOUTSAcciónTool to retrieve a list of payouts associated with your account. use when you need to list withdrawal transactions after authentication.
GIVEBUTTER_GET_PAYOUTSAcciónTool to retrieve a list of payouts associated with your account. use when you need to list withdrawal transactions after authentication.
Parámetros de entrada
pageintegerPage number for pagination, must be >= 1.
limitintegerNumber of payouts to return per page, must be >= 1.
Parámetros de salida
dataobject[]ObligatorioList of payouts associated with the account.
metaobjectObligatorioPagination metadata.
errorstringError if any occurred during the execution of the action
linksobjectObligatorioPagination links.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get PlansGIVEBUTTER_GET_PLANSAcciónTool to retrieve a list of plans associated with your account. use after authentication to fetch recurring donation plans.
GIVEBUTTER_GET_PLANSAcciónTool to retrieve a list of plans associated with your account. use after authentication to fetch recurring donation plans.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TeamsGIVEBUTTER_GET_TEAMSAcciónTool to retrieve a list of teams for a specific campaign. use after creating or updating a campaign when you need to list fundraising teams. example: "get teams for campaign camp123".
GIVEBUTTER_GET_TEAMSAcciónTool to retrieve a list of teams for a specific campaign. use after creating or updating a campaign when you need to list fundraising teams. example: "get teams for campaign camp123".
Parámetros de entrada
campaign_idstringObligatorioUnique identifier of the campaign whose teams to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TicketsGIVEBUTTER_GET_TICKETSAcciónTool to retrieve a list of tickets. use when you need to list all tickets for your account after authentication.
GIVEBUTTER_GET_TICKETSAcciónTool to retrieve a list of tickets. use when you need to list all tickets for your account after authentication.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TransactionsGIVEBUTTER_GET_TRANSACTIONSAcciónTool to retrieve a list of transactions associated with your account. use when you need to list all donations and payments, optionally filtered by scope.
GIVEBUTTER_GET_TRANSACTIONSAcciónTool to retrieve a list of transactions associated with your account. use when you need to list all donations and payments, optionally filtered by scope.
Parámetros de entrada
scopestringenumScope of transactions to retrieve: 'account' (default), 'beneficiary', or 'chapter'.
accountbeneficiarychapter
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get WebhooksGIVEBUTTER_GET_WEBHOOKSAcciónTool to retrieve all webhooks configured for your account. use after obtaining valid authentication.
GIVEBUTTER_GET_WEBHOOKSAcciónTool to retrieve all webhooks configured for your account. use after obtaining valid authentication.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update CampaignGIVEBUTTER_UPDATE_CAMPAIGNAcciónTool to update an existing campaign's details by its id. use when you need to modify campaign attributes after creation.
GIVEBUTTER_UPDATE_CAMPAIGNAcciónTool to update an existing campaign's details by its id. use when you need to modify campaign attributes after creation.
Parámetros de entrada
goalintegerCampaign goal amount in cents (e.g., $10.00 -> 1000).
metaobjectSEO meta tags for the campaign page.
slugstringUnique slug for the campaign; auto-generated if omitted.
typestringenumType of the campaign.
generalcollectfundraiseeventcoverobjectBanner image settings; include only when updating the cover.
titlestringPrimary title of the campaign.
end_atstringUTC datetime string when the campaign ends (e.g., '2024-12-31T23:59:59Z').
currencystringCurrency code; only USD is currently supported.
subtitlestringOptional subtitle displayed under the title.
campaign_idstringObligatorioUnique identifier of the campaign to update.
descriptionstringHTML content for the campaign description.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ContactGIVEBUTTER_UPDATE_CONTACTAcciónTool to update an existing contact's details by contact id. use when modifying contact information after confirming the contact id. only provided fields will be updated.
GIVEBUTTER_UPDATE_CONTACTAcciónTool to update an existing contact's details by contact id. use when modifying contact information after confirming the contact id. only provided fields will be updated.
Parámetros de entrada
emailstringEmail address of the contact.
phonestringPhone number of the contact.
addressobjectAddress details to update
last_namestringLast name of the contact.
contact_idstringObligatorioID of the contact to update.
first_namestringFirst name of the contact.
custom_fieldsobject[]List of custom field updates (id and new value).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update WebhookGIVEBUTTER_UPDATE_WEBHOOKAcciónTool to update an existing webhook subscription's details. use when you need to modify a webhook's name, url, trigger events, or enabled state after confirming its id. example: "update webhook wh 1234567890 to point to https://example.com/hook, enable transaction.succeeded only."
GIVEBUTTER_UPDATE_WEBHOOKAcciónTool to update an existing webhook subscription's details. use when you need to modify a webhook's name, url, trigger events, or enabled state after confirming its id. example: "update webhook wh 1234567890 to point to https://example.com/hook, enable transaction.succeeded only."
Parámetros de entrada
idstringObligatorioUnique identifier of the webhook to update
urlstringThe HTTPS endpoint URL that will receive webhook payloads.
namestringNew friendly name for the webhook subscription.
eventsstring[]List of event types that will trigger this webhook subscription. Available: campaign.created, campaign.updated, ticket.created, transaction.succeeded, contact.created, plan.canceled, plan.created, plan.resumed, plan.updated
enabledbooleanWhether the webhook is active (true) or disabled (false).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not