Skip to main content
WEBHOOK

Authorizations

​
X-HG-Webhook-Signature
string
header
required

HMAC-SHA256 signature of the raw JSON body. Format: sha256=<hex>. When you configure a webhook signing secret in account settings, HG.Cash includes this header on every webhook POST. Verify the signature in your endpoint to ensure the request is authentic.

Body

application/json

Payload sent to your webhook endpoint when a claim status changes (admin update or COELSA auto-reconcile).

Headers: When you configure a webhook signing secret in account settings, HG.Cash sends the header X-HG-Webhook-Signature: sha256=<hex> where the value is HMAC-SHA256 of the raw JSON body using your secret. Verify this to ensure the request is authentic.

Notes:

  • Numeric values (like amount) are sent as strings to preserve precision.
  • fileUrl is not included (signed URLs expire).
  • Webhooks are not sent on claim create or comment-only updates.
  • Configure your webhook URL in user settings.
​
topic
enum<string>
required

Webhook topic for routing (always CLAIM for claim webhooks)

Available options:
CLAIM
Example:

"CLAIM"

​
eventType
enum<string>
required

Event kind within the topic

Available options:
status_change
Example:

"status_change"

​
id
string<uuid>
required

Claim ID

​
status
enum<string>
required
Available options:
OPEN,
UNDER_REVIEW,
RESOLVED,
REJECTED
​
operationNumber
string
required
​
coelsaCode
string
required
​
amount
string | null
required

Decimal amount formatted with 2 decimal places

​
currency
enum<string>
required
Available options:
ARS,
USD,
USDT
​
extractedData
object
required
​
originalFilename
string | null
required
​
mimeType
string | null
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
accountId
string<uuid> | null
​
transactionId
string<uuid> | null

Linked transaction ID when reconciliation has matched the claim

​
comment
string

Latest comment text when the status update included a comment (ISO timestamp prefix stripped)