Credit Note Created

Event Type

credit_note_created

Summary

Sent when a credit note is created. Company webhooks receive events for their records; agency delivery is limited to records belonging to that agency. MSP-to-client records are excluded from agency delivery. Fetch full details from GET /credit-notes/{id}.

Access

Company and agency webhooks. Agency delivery is limited to that agency’s records and excludes MSP-to-client records.

Delivery

Requidex sends a signed POST request with Content-Type: application/json to the configured webhook URL. Return a 2xx response after accepting the event for processing. Duplicate or out-of-order deliveries are possible; deduplicate by event ID.

See delivery headers, signature verification and retry handling for the shared contract. The webhook signing secret is separate from an API key used to fetch the record.

Payload Fields

Field	Type	Required	Description
id	string	Yes	Stable event identifier, reused for delivery retries
type	string	Yes	credit_note_created
createdAt	string	Yes	Event creation time in ISO 8601 UTC format
data	object	Yes	Affected resource reference; not a snapshot of the changed record Show child attributes creditNote object — Affected credit-note reference Show child attributes id string — Identifier used by the corresponding detail endpoint
test	boolean	No	Present and true for test deliveries; the resource ID is test

Payload Example

{
  "id": "evt_01K1WEBHOOKEXAMPLE",
  "type": "credit_note_created",
  "createdAt": "2026-09-10T12:00:00.000Z",
  "data": {
    "creditNote": {
      "id": "507f1f77bcf86cd799439013"
    }
  }
}

Read the Affected Record

The payload contains the full object ID in data.creditNote.id. Fetch the record with GET /credit-notes/{id}.

The follow-up API request uses your API key and the endpoint’s scope and access rules. A webhook subscription does not grant additional API access. Test deliveries include test: true and use the resource ID test; do not fetch a business record for those deliveries.