Report a payment result for an external app

POSThttps://howdybell.com/api/oauth/billing/webhook

This endpoint allows marketplace app developers to notify the system about a customer's payment status. It validates the app credentials and the payment details, then records the transaction. Returns 401 for invalid credentials, 422 for validation errors, or 404 if the target location or company is not found.

Parameters

x-hb-client-keystringRequiredheader
Your app client ID.
x-hb-client-secretstringRequiredheader
Your app client secret.

Request body

clientIdstringRequired
The client ID of the app making the request.
authTypestringRequired
The type of entity being billed. Must be "location" or "company".
locationIdinteger
The ID of the location if authType is "location".
companyIdinteger
The ID of the company if authType is "company".
amountobjectRequired
The payment amount.
statusstringRequired
The payment status. Must be "COMPLETED" or "FAILED".
paymentTypestringRequired
The type of payment. Must be "one_time" or "recurring".
paymentIdstring
The external payment reference ID. Required if paymentType is "one_time".
subscriptionIdstring
The external subscription reference ID.

Responses

200

okboolean

401

errorstring

404

422

RequestcURL

curl -X POST "https://howdybell.com/api/oauth/billing/webhook" \
  -H "Authorization: Bearer $HOWDYBELL_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "clientId": "string",
  "authType": "string",
  "locationId": 1,
  "companyId": 1,
  "amount": {},
  "status": "string",
  "paymentType": "string",
  "paymentId": "string",
  "subscriptionId": "string"
}'

Response200

{
  "ok": true
}