List Webhooks - Capa.fi

List webhook notifications

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

import requests

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

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', 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",
  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"

	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")
  .header("partner-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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": {
    "count": 1,
    "total": 42,
    "data": [
      {
        "id": "8374f327-38bd-4b0b-b8a7-2524599eb903",
        "status": "FAILED",
        "eventType": "CREATED_ON_RAMP",
        "retryAttempts": 5,
        "manualRetryCount": 1,
        "createdAt": "2026-01-15T10:30:00.000Z",
        "updatedAt": "2026-01-15T10:35:00.000Z"
      }
    ]
  }
}

GET

api

partner

webhook-notifications

List webhook notifications

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

import requests

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

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', 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",
  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"

	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")
  .header("partner-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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": {
    "count": 1,
    "total": 42,
    "data": [
      {
        "id": "8374f327-38bd-4b0b-b8a7-2524599eb903",
        "status": "FAILED",
        "eventType": "CREATED_ON_RAMP",
        "retryAttempts": 5,
        "manualRetryCount": 1,
        "createdAt": "2026-01-15T10:30:00.000Z",
        "updatedAt": "2026-01-15T10:35:00.000Z"
      }
    ]
  }
}

Returns a paginated list of webhook notifications sent on behalf of your partner account. Filter by status to quickly surface failed deliveries that may need attention.

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

Important Notes

Scoped access: Only notifications belonging to your partner account are returned.
Pagination: Use skip and limit to page through results. limit defaults to 20 and cannot exceed 100.
eventType: The eventType field reflects the event value from the notification payload (e.g. CREATED_ON_RAMP, CREATED_CROSS_RAMP, VERIFIED_USER).

Use Cases

Monitor failed deliveries: Filter by status=FAILED to identify notifications that need to be retried.
Reconciliation: Cross-reference notification timestamps against your internal event log.
Audit trail: Review all webhook activity for compliance or debugging.

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
400	`INVALID_USER_INPUT_ERROR`	”Invalid User Input” (invalid query parameter)

Authorizations

partner-api-key

string

header

required

API key for the affiliated partner performing the request.

Query Parameters

status

enum<string>

Filter by delivery status

Available options:

PENDING,

FAILED,

SENT,

NOT_SENT

skip

number

The number of elements to exclude from the results.

limit

number

The maximum amount of results to return. Defaults to 20, maximum 100.

sortBy

string

Supported values:

createdAt

Response

Returns a paginated list of webhook notifications for the partner.

success

boolean

Example:

true

data

object

Show child attributes

Update Webhook Settings Get Webhook

⌘I

​Important Notes

​Use Cases

​Error Codes

​Common Errors

​Endpoint-Specific Errors

Authorizations

Query Parameters

Response

Important Notes

Use Cases

Error Codes

Common Errors

Endpoint-Specific Errors