API Reference / Webhooks REST

Actions

Returns a single delivery, including the exact payload that was sent and an excerpt of the response your endpoint returned.

Not found and not yours are the same answer: A delivery belonging to another merchant returns 404 Not Found, identical to one that does not exist, so this endpoint cannot be used to probe for foreign delivery IDs.

Response shape: This operation returns the delivery object at the top level, not the { error, message } envelope used by the older payment endpoints.

GET/v1/notifications/{id}

Get a notification delivery

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.

Path parameters

idstringrequired

The ID of the delivery, as returned by the list operation.

Responses

200The delivery.

idstringrequired

Unique ID of this delivery. Pass it to the get and replay operations.

Example68a1b2c3d4e5f6a7b8c9d0e1

createdAtstringdate-timerequired

When this attempt was made.

Example2026-08-01T12:00:05.412Z

identityIdstring

The identity the notified transaction belongs to.

Example67a02f34ad9aa801a60144ea

transactionIdstring

The transaction the event is about.

Example67a0307eaddea901a60144ec

eventTypestring

The event name that was sent. Same values as the eventType field of the webhook-transaction-event payload.

Examplepayment.received

reasonstring

Raw discriminator that produced the eventType, for example settled or refundCreated.

Examplereceived

statusstringrequired

deliveredfailedskipped

httpStatusintegerrequired

HTTP status your endpoint returned, or 0 when the request never completed — a timeout, DNS or TLS failure.

Example502

attemptsintegerrequired

How many HTTP requests this single delivery row represents.

Example1

targetHoststring

Host the request was sent to. Only the host is recorded, never the full URL, path or query string.

Examplehooks.merchant.com

testModebooleanrequired

Whether this delivery originated in the sandbox environment.

Examplefalse

isReplaybooleanrequired

True when this row was produced by the replay operation.

Examplefalse

replayOfstring

ID of the delivery this row repeats. Present only when isReplay is true. The same value is sent to your endpoint as the X-Webhook-Replay-Of header, which is how you deduplicate a replay.

Example68a1b2c3d4e5f6a7b8c9d0e1

requestedBystring

Who requested the replay. Not populated yet — the audit row currently records when (createdAt) and which (replayOf) but no actor. Treat it as absent until that ships.

Exampleops:felipe@conomyhq.com

payloadobjectshow 5 properties

Webhook payload sent by Conomy to the client URL.

responseBodyExcerptstring

First 500 characters of your endpoint's response body, kept for diagnosis. Truncated, never the full body.

Example{"ok":true}

errorMessagestring

Transport-level error when the request never reached your endpoint. Absent when the request completed.

ExamplePost "https://hooks.merchant.com/conomy"…

401Missing or invalid authentication token.

errorobjectshow 2 properties

messagestringnullable

Human-readable message. May be null.

404No delivery with this ID is visible to your credential — either it does not exist, or it belongs to another merchant.

errorstring

Examplenot found

500Unexpected internal server error.

errorobjectshow 2 properties

messagestringnullable

Human-readable message. May be null.

CodeTry it Workbench

Request

HTTPcurlTypeScriptPythonGoRust

GET /sandbox/v1/notifications/{id} 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/{id}' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'conomyhq-api-version: 24-04-2025'

const response = await fetch('https://api.conomyhq.com/sandbox/v1/notifications/{id}', {
  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/{id}',
    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/{id}", 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/{id}")
        .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 404 400 401 403 422 500

{
  "id": "68a1b2c3d4e5f6a7b8c9d0e1",
  "createdAt": "2026-08-01T12:00:05.412Z",
  "identityId": "67a02f34ad9aa801a60144ea",
  "transactionId": "67a0307eaddea901a60144ec",
  "eventType": "payment.received",
  "reason": "received",
  "status": "delivered",
  "httpStatus": 502,
  "attempts": 1,
  "targetHost": "hooks.merchant.com"
}

{
  "error": "not found"
}

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

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

{
  "error": {
    "type": "forbidden",
    "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*

Path parameters

id*

Send →