Skip to main content
GET
/
api
/
partner
/
v2
/
webhook-notifications
List webhook notifications
curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v2/webhook-notifications \
  --header 'partner-api-key: <partner-api-key>'
{
  "success": true,
  "data": {
    "count": 10,
    "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"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.capa.fi/llms.txt

Use this file to discover all available pages before exploring further.

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 StatusCodeMessage
401UNAUTHORIZED”API Key is missing”
401UNAUTHORIZED”Invalid API Key format”
401UNAUTHORIZED”Invalid API Key”
403INVALID_PARTNER_FLOW”The partner has an invalid flow.”

​
Endpoint-Specific Errors

HTTP StatusCodeMessage
400INVALID_USER_INPUT_ERROR”Invalid User Input” (invalid query parameter)

Headers

​
partner-api-key
string
required

Api key for the affiliated partner that is 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

200 - application/json

Returns a paginated list of webhook notifications for the partner.

​
success
boolean
Example:

true

​
data
object