API Reference / Webhooks REST

Actions

Returns the audit log of the webhook notifications Conomy has attempted to deliver to your endpoint, newest first. Use it to confirm what was sent, diagnose an event you never received, and find the delivery you want to replay.

Scope: Results are always limited to your own deliveries. The merchant is resolved from the credential on the request and cannot be overridden by any query parameter, so there is no way to read another merchant's log.

Retention: Rows are kept indefinitely. Both first attempts and replays appear here; a replay is a separate row linked to the original through replayOf.

Filters are permissive: An unrecognised value for status, testMode, from or to is ignored rather than rejected, so a typo in a filter widens the result set instead of returning 400 Bad Request. Check the fields on the rows you get back rather than assuming a filter was applied.

Response shape: This operation returns deliveries and nextCursor at the top level, not the { error, message } envelope used by the older payment endpoints. Every row carries its full payload, which is why limit is capped at 200.

GET/v1/notifications

List notification deliveries

Headers

Authorizationstringrequired

Bearer access token returned by the authentication endpoint.

conomyhq-api-versionstring

API version selector for Conomy endpoints. Use 24-04-2025 for the current version.

Query parameters

transactionIdstring

Return only deliveries for this transaction.

identityIdstring

Return only deliveries for this identity.

eventTypestring

Return only deliveries for this event name. The authoritative list of values is the eventType enum of the webhook-transaction-event schema.

reasonstring

Return only deliveries whose raw discriminator matches, for example settled or refundCreated.

statusstring

Return only deliveries with this outcome.

deliveredfailedskipped

testModeboolean

true returns only sandbox deliveries, false only live ones. Omit it to return both.

fromstring

Only deliveries created at or after this instant, inclusive. An unparseable value is ignored.

tostring

Only deliveries created strictly before this instant, exclusive. An unparseable value is ignored.

limitinteger≥ 1≤ 200

Maximum rows to return. Defaults to 50 and is clamped to 200; a value outside the range is clamped rather than rejected.

Default50

cursorstring

Opaque pagination cursor. Pass the nextCursor from the previous response to fetch the following page. Do not construct or parse it.

Responses

200The requested page of deliveries, newest first.

deliveriesobject[]requiredshow items

nextCursorstringrequired

Cursor for the next page, or an empty string when this is the last page.

401Missing or invalid authentication token.

errorobjectshow 2 properties

messagestringnullable

Human-readable message. May be null.

500Unexpected internal server error.

errorobjectshow 2 properties

messagestringnullable

Human-readable message. May be null.

CodeTry it Workbench

Request

HTTPcurlTypeScriptPythonGoRust

GET /sandbox/v1/notifications HTTP/1.1
Host: api.conomyhq.com
Authorization: Bearer {ACCESS_TOKEN}
conomyhq-api-version: 24-04-2025

curl -X GET \
  'https://api.conomyhq.com/sandbox/v1/notifications' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'conomyhq-api-version: 24-04-2025'

const response = await fetch('https://api.conomyhq.com/sandbox/v1/notifications', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer {ACCESS_TOKEN}',
    'conomyhq-api-version': '24-04-2025',
  },
});

const data = await response.json();

import requests

response = requests.get(
    'https://api.conomyhq.com/sandbox/v1/notifications',
    headers={
    'Authorization': 'Bearer {ACCESS_TOKEN}',
    'conomyhq-api-version': '24-04-2025',
    }
)

data = response.json()

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.conomyhq.com/sandbox/v1/notifications", nil)
	req.Header.Set("Authorization", "Bearer {ACCESS_TOKEN}")
	req.Header.Set("conomyhq-api-version", "24-04-2025")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()

	var data map[string]any
	json.NewDecoder(resp.Body).Decode(&data)
}

use reqwest::Client;
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let resp = client
        .get("https://api.conomyhq.com/sandbox/v1/notifications")
        .header("Authorization", "Bearer {ACCESS_TOKEN}")
        .header("conomyhq-api-version", "24-04-2025")
        .send()
        .await?;

    let data: serde_json::Value = resp.json().await?;
    Ok(())
}

Response

200 400 401 403 404 422 500

{
  "deliveries": [
    {
      "id": "68a1b2c3d4e5f6a7b8c9d0e1",
      "createdAt": "2026-08-01T12:00:05.412Z",
      "status": "delivered",
      "httpStatus": 502,
      "attempts": 1,
      "testMode": false,
      "isReplay": false
    }
  ],
  "nextCursor": "string"
}

{
  "error": {
    "type": "bad_request",
    "info": null
  },
  "message": null
}

{
  "error": {
    "type": "unauthorized",
    "info": null
  },
  "message": null
}

{
  "error": {
    "type": "forbidden",
    "info": null
  },
  "message": null
}

{
  "error": {
    "type": "not_found",
    "info": null
  },
  "message": null
}

{
  "error": {
    "type": "validation_error",
    "info": {
      "field": "string",
      "message": "string"
    }
  },
  "message": null
}

{
  "error": {
    "type": "internal_error",
    "info": null
  },
  "message": null
}

Requestsandbox

Authentication

Bearer token*

Query parameters

transactionId

identityId

eventType

reason

status

testMode

from

to

limit

cursor

Send →