Get Webhook - Capa.fi

Get webhook notification details

curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v2/webhook-notifications/{id} \
  --header 'partner-api-key: <api-key>'

import requests

url = "https://staging-api.capa.fi/api/partner/v2/webhook-notifications/{id}"

headers = {"partner-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'partner-api-key': '<api-key>'}};

fetch('https://staging-api.capa.fi/api/partner/v2/webhook-notifications/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging-api.capa.fi/api/partner/v2/webhook-notifications/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "partner-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://staging-api.capa.fi/api/partner/v2/webhook-notifications/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("partner-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://staging-api.capa.fi/api/partner/v2/webhook-notifications/{id}")
  .header("partner-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging-api.capa.fi/api/partner/v2/webhook-notifications/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["partner-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": "8374f327-38bd-4b0b-b8a7-2524599eb903",
    "status": "FAILED",
    "retryAttempts": 5,
    "manualRetryCount": 1,
    "payload": {
      "type": "TRANSACTION",
      "event": "CREATED_ON_RAMP",
      "externalUserId": "18c54df0-1e62-4fee-8864-9b7512a0748c",
      "transactionId": "14f6ba28-d285-4658-8dd7-8a1d903838c8",
      "firstName": "Martin",
      "lastName": "Smith"
    },
    "latestErrorPayload": {
      "success": false,
      "error": {
        "message": "Token \"2a7db920-1987-451f-9888-9262dc0f2e22\" not found",
        "id": ""
      }
    },
    "lastManualRetryAt": "2026-01-15T10:35:00.000Z",
    "version": 1,
    "createdAt": "2026-01-15T10:30:00.000Z",
    "updatedAt": "2026-01-15T10:35:00.000Z"
  }
}

GET

api

partner

webhook-notifications

{id}

Get webhook notification details

curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v2/webhook-notifications/{id} \
  --header 'partner-api-key: <api-key>'

import requests

url = "https://staging-api.capa.fi/api/partner/v2/webhook-notifications/{id}"

headers = {"partner-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'partner-api-key': '<api-key>'}};

fetch('https://staging-api.capa.fi/api/partner/v2/webhook-notifications/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging-api.capa.fi/api/partner/v2/webhook-notifications/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "partner-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://staging-api.capa.fi/api/partner/v2/webhook-notifications/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("partner-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://staging-api.capa.fi/api/partner/v2/webhook-notifications/{id}")
  .header("partner-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging-api.capa.fi/api/partner/v2/webhook-notifications/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["partner-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": "8374f327-38bd-4b0b-b8a7-2524599eb903",
    "status": "FAILED",
    "retryAttempts": 5,
    "manualRetryCount": 1,
    "payload": {
      "type": "TRANSACTION",
      "event": "CREATED_ON_RAMP",
      "externalUserId": "18c54df0-1e62-4fee-8864-9b7512a0748c",
      "transactionId": "14f6ba28-d285-4658-8dd7-8a1d903838c8",
      "firstName": "Martin",
      "lastName": "Smith"
    },
    "latestErrorPayload": {
      "success": false,
      "error": {
        "message": "Token \"2a7db920-1987-451f-9888-9262dc0f2e22\" not found",
        "id": ""
      }
    },
    "lastManualRetryAt": "2026-01-15T10:35:00.000Z",
    "version": 1,
    "createdAt": "2026-01-15T10:30:00.000Z",
    "updatedAt": "2026-01-15T10:35:00.000Z"
  }
}

Retrieves the full details of a single webhook notification, including its original payload, delivery status, retry history, and the error response from the last failed attempt.

For an overview of webhook events and payload structures, see the Webhooks Guide.

Important Notes

latestErrorPayload: Contains the error body returned by your endpoint on the last failed delivery attempt. Use this to diagnose why delivery failed (e.g. a 500 from your server).
retryAttempts: The number of automatic delivery attempts made by Capa. After the maximum is reached, status transitions to FAILED.
manualRetryCount: Incremented each time you call the retry endpoint. A maximum of 3 manual retries are allowed per notification.

Status Reference

Status	Description
`PENDING`	Queued for delivery or currently being retried
`SENT`	Successfully delivered to your endpoint
`FAILED`	All automatic delivery attempts exhausted
`NOT_SENT`	No webhook URL was configured at the time of the event

Error Codes

Common Errors

HTTP Status	Code	Message
401	`UNAUTHORIZED`	”API Key is missing”
401	`UNAUTHORIZED`	”Invalid API Key format”
401	`UNAUTHORIZED`	”Invalid API Key”
403	`INVALID_PARTNER_FLOW`	”The partner has an invalid flow.”

Endpoint-Specific Errors

HTTP Status	Code	Message
404	`NOT_FOUND`	”Webhook notification not found”

Authorizations

partner-api-key

string

header

required

API key for the affiliated partner performing the request.

Path Parameters

string

required

The webhook notification ID

Example:

"8374f327-38bd-4b0b-b8a7-2524599eb903"

Response

Returns the full details of a single webhook notification including its payload and error information.

success

boolean

Example:

true

data

object

Show child attributes

List Webhooks Retry Webhook

⌘I

​Important Notes

​Status Reference

​Error Codes

​Common Errors

​Endpoint-Specific Errors

Authorizations

Path Parameters

Response

Important Notes

Status Reference

Error Codes

Common Errors

Endpoint-Specific Errors