Skip to content
Aller au contenu
Charitips

API reference · Webhooks

Search logs

GET/v1/webhooks/logs

List and search webhook logs

Requires a Bearer access token.

Parameters

2 of 8 fields have no description in the spec.

  • start#string (date)in query

    The start time for the query. Defaults to one hour ago.

  • end#string (date)in query

    The end time for the query. Defaults to now.

  • limit#numberin queryintegerminimum 1maximum 500

    The max number of entries to return. Defaults to 100. Maximum is 500.

  • entityId#stringin queryUUID

    The id of the entity which triggered the webhook.

  • webhookId#stringin queryUUID

    The id of your webhook handler.

  • accountId#stringin queryUUID

    Id of the account. Only useful for Platform customers to filter webhook logs by child accounts.

  • event#stringin queryone of donation_create, donation_update, vote_create, vote_update, recurringdonation_create, recurringdonation_update, campaign_create, campaign_update, charitiesselection_create, charitiesselection_update, paymentmethod_create, charity_publish, charityprofile_update, fiscalreceipt_generated, charity_profile_update, file_generated

    donation_createdonation_updatevote_createvote_updaterecurringdonation_createrecurringdonation_updatecampaign_createcampaign_updatecharitiesselection_createcharitiesselection_updatepaymentmethod_createcharity_publishcharityprofile_updatefiscalreceipt_generatedcharity_profile_updatefile_generated

  • status#stringin queryone of SUCCEEDED, FAILED

    SUCCEEDEDFAILED

Response

200 · WebhookEvent[]

8 of 9 fields have no description in the spec.

  • accountId#stringalways returned

  • event#objectalways returned

  • entityId#stringalways returned

  • webhookId#stringalways returned

  • target#stringalways returned

    Webhook target URL

  • payload#objectalways returned

  • status#objectalways returned

  • response#objectalways returned

    2 child fields
    • statusnumber

    • dataobject

  • sentAt#string (date-time)always returned

Errors

  • 400A field is missing, has the wrong type, or is not part of the request schema.

    Every request with a body or query is validated.

    {
      "statusCode": 400,
      "message": [
        "amount must not be less than 1",
        "property foo should not exist"
      ],
      "error": "Bad Request"
    }
  • 401Unauthorized

    Missing, expired or invalid access token.

    {
      "statusCode": 401,
      "message": "Unauthorized"
    }
  • 402Plan upgrade required
    {
      "statusCode": 402,
      "message": "Plan upgrade required"
    }
  • 403Account closed
    {
      "message": "Account closed",
      "code": "ACCOUNT_CLOSED"
    }
GET /v1/webhooks/logs
curl -X GET https://api.sandbox.charitips.com/v1/webhooks/logs \  -H "Authorization: Bearer $CHARITIPS_TOKEN"
Built from the spec and the API code

Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.