Skip to content
Aller au contenu
Charitips

API reference · Webhooks

Get a webhook

GET/v1/webhooks/{webhookId}

No description in the spec yet.

Requires a Bearer access token.

Parameters

This field has no description in the spec.

  • webhookId#stringin pathrequired

Response

200 · Webhook

No field is described in the spec.

  • webhookId#stringalways returned

  • name#stringalways returned

  • target#stringalways returned

  • events#string[]always returned

  • authenticationStrategy#WebhookAuthenticationStrategyalways returned

    BASICBEARER

  • accessToken#stringalways returned

  • signingKey#string

  • accountId#stringalways returned

  • createdAt#string (date-time)always returned

  • updatedAt#string (date-time)always returned

Errors

  • 401Unauthorized

    Missing, expired or invalid access token.

    {
  "statusCode": 401,
  "message": "Unauthorized"
}
  • 403Account closed
    {
  "message": "Account closed",
  "code": "ACCOUNT_CLOSED"
}
  • 404Not Found
    {
  "statusCode": 404,
  "message": "Not Found"
}
GET /v1/webhooks/<webhookId>
curl -X GET https://api.sandbox.charitips.com/v1/webhooks/<webhookId> \  -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.