Handle payments events - Upwell Developer Docs

{ "id": "whe_example", "createdAt": "2024-11-17T18:31:47.656611", "updatedAt": "2024-11-17T18:31:47.656611", "scheduledAt": null, "processedAt": null, "status": "PENDING", "operation": "UPDATE", "payload": { "new": { "id": "pym_example", "fees": "0", "notes": "sample note", "status": "completed", "currency": "USD", "tenant_id": "ten_example", "check_date": null, "created_at": "2024-11-16T00:59:33.492433+00:00", "invoice_id": null, "updated_at": "2024-11-17T18:31:43.868708+00:00", "customer_id": "cus_example", "total_amount": "12500", "exchange_rate": null, "source_system": null, "source_system_id": null, "transaction_date": "2023-01-04", "source_system_meta": { "mergeId": "3358e764-0b63-4c68-8166-4c6e5ee44b5a", "remoteId": "72", "fieldMappings": { "organizationDefinedTargets": null, "linkedAccountDefinedTargets": null }, "mergeCustomerId": "1d53a67e-95ac-4409-be74-af9ddc7c83ce", "remoteUpdatedAt": "2023-01-26T20:50:23Z", "remoteWasDeleted": false, "trackingCategories": [] }, "check_or_ach_number": null, "total_amount_with_fees": null }, "old": { "id": "pym_example", "fees": "0", "notes": null, "status": "completed", "currency": null, "tenant_id": "ten_example", "check_date": null, "created_at": "2024-11-16T00:59:33.492433+00:00", "invoice_id": null, "updated_at": "2024-11-17T18:30:37.07542+00:00", "customer_id": "cus_example", "total_amount": "11500", "exchange_rate": null, "source_system": null, "source_system_id": null, "transaction_date": "2023-01-04", "source_system_meta": { "mergeId": "3358e764-0b63-4c68-8166-4c6e5ee44b5a", "remoteId": "72", "fieldMappings": { "organizationDefinedTargets": null, "linkedAccountDefinedTargets": null }, "mergeCustomerId": "1d53a67e-95ac-4409-be74-af9ddc7c83ce", "remoteUpdatedAt": "2023-01-26T20:50:23Z", "remoteWasDeleted": false, "trackingCategories": [] }, "check_or_ach_number": null, "total_amount_with_fees": null } }, "table": "payments", "webhookSubscriptionId": "whs_example", "resourceId": "pym_example", "retryOfId": null, "retries": [] }

Authorizations

Authorization

string

header

required

Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account → API keys) and are scoped to one organization.

Body

application/json

Details that are sent over to the webhook

A payload structure for webhook events triggered by operations in Upwell, detailing the affected resource, tenant, operation type, and resource state.

string

The unique identifier for the event.

trigger

string

The trigger string for this event (e.g. update.carrier_invoice.status.APPROVED). Branch on this — see the webhook event catalog.

createdAt

string<date-time>

The timestamp when the event was created.

updatedAt

string<date-time>

The timestamp when the event was last updated.

scheduledAt

string<date-time> | null

The timestamp when the event is scheduled to be processed.

processedAt

string<date-time> | null

The timestamp when the event was processed.

status

string

The status of the event (e.g., PENDING).

operation

enum<string>

The operation type that triggered the event.

Available options:

INSERT,

UPDATE,

DELETE

payload

object

Data regarding the state of the resource involved in the event.

Show child attributes

table

string

The type of resource in the Upwell application where the event occurred.

resourceId

string

The unique identifier for the resource affected by the event.

webhookSubscriptionId

string

The unique identifier for the webhook subscription.

Response

200

Return a 200 status to indicate that the data was received successfully