Webhook Requests

Inspect and retry webhook delivery attempts.

List Webhook Requests

get

List webhook requests for a business.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

event_typestring · nullableOptional

event_namestring · nullableOptional

pageintegerOptionalDefault: 1

sizeintegerOptionalDefault: 10

Responses

200

A page of delivery attempts, newest first.

application/json

statusstringOptionalDefault: success

401

Unauthorized

application/json

422

Unprocessable Entity - Validation Error

application/json

500

Internal Server Error

application/json

get/api/v2/webhooks/requests

GET /api/v2/webhooks/requests HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "items": [
      {
        "id": "018f4d2f-7c3b-7e59-8f4d-2f7c3b7e5900",
        "request_id": "018f4d2f-7c3b-7e59-8f4d-2f7c3b7e5a00",
        "execution_count": 0,
        "webhook_url": "https://partner.example.com/ospree/webhooks",
        "event_type": "travel_rule",
        "event_name": "INCOMING_TRANSFER",
        "status": 200,
        "timestamp": "2026-08-31T11:14:02Z",
        "request_payload": {
          "event_name": "INCOMING_TRANSFER",
          "data": {
            "transfer_id": "067fd57d-efe3-7eab-8000-04d8f072e418"
          }
        }
      },
      {
        "id": "018f4d2f-7c3b-7e59-8f4d-2f7c3b7e5901",
        "request_id": "018f4d2f-7c3b-7e59-8f4d-2f7c3b7e5a01",
        "execution_count": 1,
        "webhook_url": "https://partner.example.com/ospree/webhooks",
        "event_type": "travel_rule",
        "event_name": "TRANSFER_COMPLETED",
        "status": 401,
        "timestamp": "2026-08-31T11:12:44Z",
        "request_payload": {
          "event_name": "TRANSFER_COMPLETED",
          "data": {
            "transfer_id": "067fd57d-efe3-7eab-8000-04d8f072e418"
          }
        },
        "error_details": {
          "reason": "Destination rejected the request",
          "body": "signature verification failed"
        }
      },
      {
        "id": "018f4d2f-7c3b-7e59-8f4d-2f7c3b7e5903",
        "request_id": "018f4d2f-7c3b-7e59-8f4d-2f7c3b7e5a01",
        "execution_count": 0,
        "webhook_url": "https://partner.example.com/ospree/webhooks",
        "event_type": "travel_rule",
        "event_name": "TRANSFER_COMPLETED",
        "status": 500,
        "timestamp": "2026-08-31T11:12:39Z",
        "request_payload": {
          "event_name": "TRANSFER_COMPLETED",
          "data": {
            "transfer_id": "067fd57d-efe3-7eab-8000-04d8f072e418"
          }
        },
        "error_details": {
          "reason": "Destination returned HTTP 500",
          "body": "internal error"
        }
      }
    ],
    "total": 3,
    "page": 1,
    "size": 50,
    "pages": 1
  }
}

Retry Webhook Request

post

Retry a previously attempted webhook delivery.

Re-sends the recorded payload to the endpoint's current URL and records a fresh delivery attempt, which is what the response carries. The original attempt is left in the log untouched.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

request_idstring · uuidRequired

Responses

200

The delivery was retried. The body is the new attempt.

application/json

statusstringOptionalDefault: success

401

Unauthorized

application/json

404

No delivery attempt with this id

application/json

422

Unprocessable Entity - Validation Error

application/json

500

Internal Server Error

application/json

post/api/v2/webhooks/requests/{request_id}

POST /api/v2/webhooks/requests/{request_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "id": "018f4d2f-7c3b-7e59-8f4d-2f7c3b7e5904",
    "request_id": "018f4d2f-7c3b-7e59-8f4d-2f7c3b7e5a01",
    "webhook_url": "https://partner.example.com/ospree/webhooks",
    "event_type": "travel_rule",
    "event_name": "TRANSFER_COMPLETED",
    "status": 200,
    "timestamp": "2026-08-31T11:59:07Z",
    "request_payload": {
      "event_name": "TRANSFER_COMPLETED",
      "data": {
        "transfer_id": "067fd57d-efe3-7eab-8000-04d8f072e418"
      }
    }
  }
}