NAiOS IconNAiOS Logo
Volver al catálogo

Givebutter

givebutter

Givebutter is a fundraising platform that offers a free, open, and public API for developers to manage campaigns, track donations, and engage with supporters.

Acciones
18
Triggers
0
Autenticación
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Tool 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_idstringObligatorio

    Unique 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create CampaignGIVEBUTTER_CREATE_CAMPAIGNAcción

Tool 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

  • goalinteger

    Campaign goal amount in cents (e.g., $1000 -> 100000).

  • metaobject

    SEO meta tags for the campaign page.

  • slugstring

    Unique slug for the campaign; auto-generated if omitted.

  • typestringObligatorioenum

    Type of the campaign.

    generalcollectfundraiseevent
  • coverobject

    Banner image settings; include only when providing a cover.

  • titlestringObligatorio

    Primary title of the campaign.

  • end_atstring

    UTC datetime string when the campaign ends.

  • currencystring

    Currency code; only USD is currently supported.

  • subtitlestring

    Optional subtitle displayed under the title.

  • descriptionstring

    HTML content for the campaign description.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create WebhookGIVEBUTTER_CREATE_WEBHOOKAcción

Tool 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

  • urlstringObligatorio

    The HTTPS endpoint URL that will receive webhook payloads.

  • namestringObligatorio

    A friendly name for the webhook subscription.

  • eventsstring[]Obligatorio

    List of event types that will trigger this webhook subscription.

  • enabledboolean

    Whether the webhook is active immediately upon creation.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete CampaignGIVEBUTTER_DELETE_CAMPAIGNAcción

Tool 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_idstringObligatorio

    Unique identifier of the campaign to delete. Cannot delete if the campaign has any funds raised.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete ContactGIVEBUTTER_DELETE_CONTACTAcción

Tool 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_idstringObligatorio

    Unique identifier of the contact to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete FundGIVEBUTTER_DELETE_FUNDAcción

Tool 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_idstringObligatorio

    Unique identifier of the fund to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete WebhookGIVEBUTTER_DELETE_WEBHOOKAcción

Tool 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_idstringObligatorio

    Unique identifier of the webhook to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get FundGIVEBUTTER_GET_FUNDAcción

Tool to retrieve details of a specific fund by its id. use after confirming the fund id is valid.

Parámetros de entrada

  • fund_idstringObligatorio

    Unique identifier of the fund to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get MembersGIVEBUTTER_GET_MEMBERSAcción

Tool 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

  • pageinteger

    Page number for pagination, must be >= 1

  • campaign_idstringObligatorio

    Unique identifier of the campaign to retrieve members from

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get PayoutsGIVEBUTTER_GET_PAYOUTSAcción

Tool to retrieve a list of payouts associated with your account. use when you need to list withdrawal transactions after authentication.

Parámetros de entrada

  • pageinteger

    Page number for pagination, must be >= 1.

  • limitinteger

    Number of payouts to return per page, must be >= 1.

Parámetros de salida

  • dataobject[]Obligatorio

    List of payouts associated with the account.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get PlansGIVEBUTTER_GET_PLANSAcción

Tool 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get TeamsGIVEBUTTER_GET_TEAMSAcción

Tool 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_idstringObligatorio

    Unique identifier of the campaign whose teams to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get TicketsGIVEBUTTER_GET_TICKETSAcción

Tool 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get TransactionsGIVEBUTTER_GET_TRANSACTIONSAcción

Tool 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

  • scopestringenum

    Scope of transactions to retrieve: 'account' (default), 'beneficiary', or 'chapter'.

    accountbeneficiarychapter

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get WebhooksGIVEBUTTER_GET_WEBHOOKSAcción

Tool to retrieve all webhooks configured for your account. use after obtaining valid authentication.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update CampaignGIVEBUTTER_UPDATE_CAMPAIGNAcción

Tool to update an existing campaign's details by its id. use when you need to modify campaign attributes after creation.

Parámetros de entrada

  • goalinteger

    Campaign goal amount in cents (e.g., $10.00 -> 1000).

  • metaobject

    SEO meta tags for the campaign page.

  • slugstring

    Unique slug for the campaign; auto-generated if omitted.

  • typestringenum

    Type of the campaign.

    generalcollectfundraiseevent
  • coverobject

    Banner image settings; include only when updating the cover.

  • titlestring

    Primary title of the campaign.

  • end_atstring

    UTC datetime string when the campaign ends (e.g., '2024-12-31T23:59:59Z').

  • currencystring

    Currency code; only USD is currently supported.

  • subtitlestring

    Optional subtitle displayed under the title.

  • campaign_idstringObligatorio

    Unique identifier of the campaign to update.

  • descriptionstring

    HTML content for the campaign description.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update ContactGIVEBUTTER_UPDATE_CONTACTAcción

Tool 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

  • emailstring

    Email address of the contact.

  • phonestring

    Phone number of the contact.

  • addressobject

    Address details to update

  • last_namestring

    Last name of the contact.

  • contact_idstringObligatorio

    ID of the contact to update.

  • first_namestring

    First name of the contact.

  • custom_fieldsobject[]

    List of custom field updates (id and new value).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update WebhookGIVEBUTTER_UPDATE_WEBHOOKAcción

Tool 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

  • idstringObligatorio

    Unique identifier of the webhook to update

  • urlstring

    The HTTPS endpoint URL that will receive webhook payloads.

  • namestring

    New 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

  • enabledboolean

    Whether the webhook is active (true) or disabled (false).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not