Skip to content
ABUNA
DocumentationLivraisons de webhooks

Référence de l'API

Livraisons de webhooks

Voyez chaque webhook envoyé à votre serveur, renvoyez-en un ou envoyez un test.

Voir en Markdown

Vérifiez quels événements ont atteint l'URL du webhook, renvoyez-en un ou envoyez un test. Une livraison de webhook est un événement envoyé à l'URL du webhook. Si votre serveur ne répond pas avec un statut 2xx, Abuna réessaie, jusqu'à 10 fois sur environ un jour. Voir Recevoir des webhooks pour les recevoir et les vérifier.

L'objet webhook delivery

Attributs

  • idstring

    Identifiant unique de la livraison. Abuna l'envoie dans l'en-tête X-Abuna-Delivery.
  • event_idstringnullable

    L'événement que la livraison envoie.
  • event_typestring

    Le type de l'événement.
  • payloadobject

    Le corps exact qu'Abuna envoie.
    Afficher les attributsMasquer les attributs
    • idstring

      L'ID de l'événement.
    • typestring

      Le type de l'événement.
    • environmentstring

      live ou test.
    • created_attimestamp

      Quand l'événement a eu lieu.
    • dataobject

      Le contenu de l'événement (son payload).
  • urlstring

    L'URL vers laquelle va la livraison.
  • statusstring

    pending pendant qu'elle attend d'être envoyée ou réessayée, delivering pendant qu'Abuna l'envoie, delivered une fois que votre serveur a répondu avec un statut 2xx, et failed après l'échec de la dernière tentative.
  • attemptsinteger

    Combien de fois Abuna a essayé de l'envoyer.
  • response_statusintegernullable

    Le statut HTTP avec lequel votre serveur a répondu en dernier.
  • last_errorstringnullable

    Pourquoi la dernière tentative a échoué.
  • created_attimestamp

    Quand la livraison a été créée, en secondes Unix.
  • delivered_attimestampnullable

    Quand votre serveur l'a acceptée.
  • next_attempt_attimestamp

    Quand Abuna essaiera de l'envoyer à nouveau, tant qu'elle est pending.
  • event_created_attimestampnullable

    Quand l'événement a eu lieu.
L'objet webhook delivery
{
  "id": "R3vH6sLd",
  "event_id": "01M7GKP458FZEMMQQ7VM7J4QK4",
  "event_type": "invoice.paid",
  "payload": {
    "created_at": 1794780106,
    "data": {
      "amount": 5000,
      "coupon_id": null,
      "credit": 0,
      "currency": "XAF",
      "discount": 0,
      "invoice_id": "OG3ZsOC7",
      "invoice_number": "ACME-000001",
      "kind": "period",
      "metadata": {
        "user_id": "42"
      },
      "paid_at": 1794780106,
      "payment": {
        "amount": 5000,
        "app_id": "qhf83tDc",
        "created_at": 1794780106,
        "currency": "XAF",
        "driver": "sandbox",
        "exchange_margin_bps": null,
        "exchange_rate": null,
        "exchange_rate_at": null,
        "fee": 100,
        "id": "tGfwt5dd",
        "marked_by_api_key_id": null,
        "marked_by_user_id": null,
        "message": null,
        "method_label": "Successful payment (test)",
        "net": null,
        "note": null,
        "original_amount": 5000,
        "original_currency": "XAF",
        "period_id": "0kYPFwxJ",
        "provider": "test",
        "provider_reference": "test_ff6aaf0182bd3f1148bd",
        "session_id": null,
        "status": "succeeded"
      },
      "period_end": 1797372106,
      "period_id": "0kYPFwxJ",
      "period_start": 1794780106,
      "promotion_code_id": null,
      "subscription": {
        "activated_at": 1794780106,
        "app_id": "qhf83tDc",
        "cancel_at": null,
        "cancel_at_period_end": false,
        "canceled_at": null,
        "created_at": 1794780106,
        "current_period_end": 1797372106,
        "current_period_start": 1794780106,
        "customer_id": "GzeUZeSV",
        "discount": null,
        "ended_reason": null,
        "id": "wTiODxvH",
        "manage_token": "ac78d36db5c13e5f1bcbb67ece2ee29137a0",
        "metadata": {
          "user_id": "42"
        },
        "price_id": "IaFQHLTL",
        "starts_at": 1794780106,
        "status": "active",
        "trial_ends_at": null
      },
      "subscription_id": "wTiODxvH"
    },
    "environment": "test",
    "id": "01M7GKP458FZEMMQQ7VM7J4QK4",
    "type": "invoice.paid"
  },
  "url": "https://example.com/webhooks",
  "status": "delivered",
  "attempts": 1,
  "response_status": 200,
  "last_error": null,
  "created_at": 1727600100,
  "delivered_at": 1727600101,
  "next_attempt_at": 1727600100,
  "event_created_at": 1727600100
}

Lister les livraisons de webhook

GET/v1/apps/{appID}/webhooks

Liste les livraisons de webhook de l'application, de la plus récente à la plus ancienne, une page à la fois.

Paramètres de requête

  • typestring

    Renvoie uniquement les livraisons de ce type d'événement, comme invoice.paid.
  • statusstring

    Renvoie uniquement les livraisons avec ce statut : pending, delivering, delivered ou failed.
  • limitinteger

    Combien de livraisons renvoyer, de 1 à 100. Par défaut : 50.
  • cursorstring

    La valeur next_cursor de la page précédente. Envoyez les mêmes filtres avec.

Renvoie items et next_cursor, comme décrit dans Listes et filtres. Une valeur non autorisée, comme un limit supérieur à 100, renvoie 422 avec le code invalid et le nom du paramètre dans errors.

GET /v1/apps/{appID}/webhooks
curl "https://api.abuna.app/v1/apps/8ddhXCDW/webhooks?status=failed" \
  -H "Authorization: Bearer sk_test_..."
Réponse
{
  "items": [
    {
      "id": "R3vH6sLd",
      "event_id": "01M7GKP458FZEMMQQ7VM7J4QK4",
      "event_type": "invoice.paid",
      "payload": {
        "created_at": 1794780106,
        "data": {
          "amount": 5000,
          "coupon_id": null,
          "credit": 0,
          "currency": "XAF",
          "discount": 0,
          "invoice_id": "OG3ZsOC7",
          "invoice_number": "ACME-000001",
          "kind": "period",
          "metadata": {
            "user_id": "42"
          },
          "paid_at": 1794780106,
          "payment": {
            "amount": 5000,
            "app_id": "qhf83tDc",
            "created_at": 1794780106,
            "currency": "XAF",
            "driver": "sandbox",
            "exchange_margin_bps": null,
            "exchange_rate": null,
            "exchange_rate_at": null,
            "fee": 100,
            "id": "tGfwt5dd",
            "marked_by_api_key_id": null,
            "marked_by_user_id": null,
            "message": null,
            "method_label": "Successful payment (test)",
            "net": null,
            "note": null,
            "original_amount": 5000,
            "original_currency": "XAF",
            "period_id": "0kYPFwxJ",
            "provider": "test",
            "provider_reference": "test_ff6aaf0182bd3f1148bd",
            "session_id": null,
            "status": "succeeded"
          },
          "period_end": 1797372106,
          "period_id": "0kYPFwxJ",
          "period_start": 1794780106,
          "promotion_code_id": null,
          "subscription": {
            "activated_at": 1794780106,
            "app_id": "qhf83tDc",
            "cancel_at": null,
            "cancel_at_period_end": false,
            "canceled_at": null,
            "created_at": 1794780106,
            "current_period_end": 1797372106,
            "current_period_start": 1794780106,
            "customer_id": "GzeUZeSV",
            "discount": null,
            "ended_reason": null,
            "id": "wTiODxvH",
            "manage_token": "ac78d36db5c13e5f1bcbb67ece2ee29137a0",
            "metadata": {
              "user_id": "42"
            },
            "price_id": "IaFQHLTL",
            "starts_at": 1794780106,
            "status": "active",
            "trial_ends_at": null
          },
          "subscription_id": "wTiODxvH"
        },
        "environment": "test",
        "id": "01M7GKP458FZEMMQQ7VM7J4QK4",
        "type": "invoice.paid"
      },
      "url": "https://example.com/webhooks",
      "status": "delivered",
      "attempts": 1,
      "response_status": 200,
      "last_error": null,
      "created_at": 1727600100,
      "delivered_at": 1727600101,
      "next_attempt_at": 1727600100,
      "event_created_at": 1727600100
    }
  ],
  "next_cursor": null
}

Renvoyer un webhook

POST/v1/apps/{appID}/webhooks/{id}/redeliver

Accepte un en-tête Idempotency-Key.

Envoie à nouveau le corps d'une livraison passée, en tant que nouvelle livraison du même événement. Elle va vers l'URL du webhook actuelle. Utilisez-la après avoir corrigé votre serveur.

Renvoie la nouvelle livraison avec le statut 201. Si l'application n'a pas d'URL du webhook, renvoie 422 avec le code webhook_url_missing. Si elle n'a aucune livraison avec cet ID, renvoie 404 avec le code not_found.

POST /v1/apps/{appID}/webhooks/{id}/redeliver
curl https://api.abuna.app/v1/apps/8ddhXCDW/webhooks/R3vH6sLd/redeliver \
  -X POST \
  -H "Authorization: Bearer sk_test_..."
Réponse
{
  "id": "K5qB9mDl",
  "app_id": "8ddhXCDW",
  "event_id": "01M7GKP458FZEMMQQ7VM7J4QK4",
  "event_type": "invoice.paid",
  "payload": "eyJjcmVhdGVkX2F0IjoxNzk0NzgwMTA2LCJkYXRhIjp7ImFtb3VudCI6NTAwMCwiY291cG9uX2lkIjpudWxsLCJjcmVkaXQiOjAsImN1cnJlbmN5IjoiWEFGIiwiZGlzY291bnQiOjAsImludm9pY2VfaWQiOiJPRzNac09DNyIsImludm9pY2VfbnVtYmVyIjoiQUNNRS0wMDAwMDEiLCJraW5kIjoicGVyaW9kIiwibWV0YWRhdGEiOnsidXNlcl9pZCI6IjQyIn0sInBhaWRfYXQiOjE3OTQ3ODAxMDYsInBheW1lbnQiOnsiYW1vdW50Ijo1MDAwLCJhcHBfaWQiOiJxaGY4M3REYyIsImNyZWF0ZWRfYXQiOjE3OTQ3ODAxMDYsImN1cnJlbmN5IjoiWEFGIiwiZHJpdmVyIjoic2FuZGJveCIsImV4Y2hhbmdlX21hcmdpbl9icHMiOm51bGwsImV4Y2hhbmdlX3JhdGUiOm51bGwsImV4Y2hhbmdlX3JhdGVfYXQiOm51bGwsImZlZSI6MTAwLCJpZCI6InRHZnd0NWRkIiwibWFya2VkX2J5X2FwaV9rZXlfaWQiOm51bGwsIm1hcmtlZF9ieV91c2VyX2lkIjpudWxsLCJtZXNzYWdlIjpudWxsLCJtZXRob2RfbGFiZWwiOiJTdWNjZXNzZnVsIHBheW1lbnQgKHRlc3QpIiwibmV0IjpudWxsLCJub3RlIjpudWxsLCJvcmlnaW5hbF9hbW91bnQiOjUwMDAsIm9yaWdpbmFsX2N1cnJlbmN5IjoiWEFGIiwicGVyaW9kX2lkIjoiMGtZUEZ3eEoiLCJwcm92aWRlciI6InRlc3QiLCJwcm92aWRlcl9yZWZlcmVuY2UiOiJ0ZXN0X2ZmNmFhZjAxODJiZDNmMTE0OGJkIiwic2Vzc2lvbl9pZCI6bnVsbCwic3RhdHVzIjoic3VjY2VlZGVkIn0sInBlcmlvZF9lbmQiOjE3OTczNzIxMDYsInBlcmlvZF9pZCI6IjBrWVBGd3hKIiwicGVyaW9kX3N0YXJ0IjoxNzk0NzgwMTA2LCJwcm9tb3Rpb25fY29kZV9pZCI6bnVsbCwic3Vic2NyaXB0aW9uIjp7ImFjdGl2YXRlZF9hdCI6MTc5NDc4MDEwNiwiYXBwX2lkIjoicWhmODN0RGMiLCJjYW5jZWxfYXQiOm51bGwsImNhbmNlbF9hdF9wZXJpb2RfZW5kIjpmYWxzZSwiY2FuY2VsZWRfYXQiOm51bGwsImNyZWF0ZWRfYXQiOjE3OTQ3ODAxMDYsImN1cnJlbnRfcGVyaW9kX2VuZCI6MTc5NzM3MjEwNiwiY3VycmVudF9wZXJpb2Rfc3RhcnQiOjE3OTQ3ODAxMDYsImN1c3RvbWVyX2lkIjoiR3plVVplU1YiLCJkaXNjb3VudCI6bnVsbCwiZW5kZWRfcmVhc29uIjpudWxsLCJpZCI6IndUaU9EeHZIIiwibWFuYWdlX3Rva2VuIjoiYWM3OGQzNmRiNWMxM2U1ZjFiY2JiNjdlY2UyZWUyOTEzN2EwIiwibWV0YWRhdGEiOnsidXNlcl9pZCI6IjQyIn0sInByaWNlX2lkIjoiSWFGUUhMVEwiLCJzdGFydHNfYXQiOjE3OTQ3ODAxMDYsInN0YXR1cyI6ImFjdGl2ZSIsInRyaWFsX2VuZHNfYXQiOm51bGx9LCJzdWJzY3JpcHRpb25faWQiOiJ3VGlPRHh2SCJ9LCJlbnZpcm9ubWVudCI6InRlc3QiLCJpZCI6IjAxTTdHS1A0NThGWkVNTVFRN1ZNN0o0UUs0IiwidHlwZSI6Imludm9pY2UucGFpZCJ9",
  "url": "https://example.com/webhooks",
  "status": "pending",
  "attempts": 0,
  "response_status": null,
  "last_error": null,
  "next_attempt_at": 1727700000,
  "leased_until": null,
  "created_at": 1727700000,
  "delivered_at": null
}

Envoyer un webhook de test

POST/v1/apps/{appID}/webhooks/test

Accepte un en-tête Idempotency-Key.

Envoie maintenant un événement ping signé vers l'URL du webhook, et vous dit comment votre serveur a répondu. Il n'est pas réessayé, et il n'apparaît ni dans vos événements ni dans vos livraisons. Son data est {"message": "A test event sent from the Abuna dashboard."}.

Attributs de la réponse

  • deliveredboolean

    Si votre serveur a répondu avec un statut 2xx.
  • response_statusintegernullable

    Le statut HTTP avec lequel votre serveur a répondu. Null s'il n'a pas répondu.
  • errorstringnullable

    Pourquoi la requête a échoué, quand votre serveur n'a pas répondu.

Renvoie 200, même quand votre serveur échoue au test. Si l'application n'a pas d'URL du webhook, renvoie 422 avec le code webhook_url_missing. Vous pouvez envoyer 10 tests par minute. Au-delà, l'API renvoie 429 avec le code rate_limited.

POST /v1/apps/{appID}/webhooks/test
curl https://api.abuna.app/v1/apps/8ddhXCDW/webhooks/test \
  -X POST \
  -H "Authorization: Bearer sk_test_..."
Réponse
{
  "delivered": true,
  "response_status": 200,
  "error": null
}

Étapes suivantes