{
"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",
"status": "SUCCEEDED",
"currency": "USD",
"tenant_id": "ten_example",
"check_date": null,
"created_at": "2024-11-16T00:59:33.492433+00:00",
"updated_at": "2024-11-17T18:31:43.868708+00:00",
"total_amount": 12500,
"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
},
"old": {
"id": "pym_example",
"status": "SUCCEEDED",
"currency": "USD",
"tenant_id": "ten_example",
"check_date": null,
"created_at": "2024-11-16T00:59:33.492433+00:00",
"updated_at": "2024-11-17T18:30:37.07542+00:00",
"total_amount": 11500,
"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
}
},
"table": "payments",
"webhookSubscriptionId": "whs_example",
"resourceId": "pym_example",
"retryOfId": null,
"retries": [],
"trigger": "update.customer_payment"
}Handle customer payment events
Customer payment creation, update and deletion send snake_case row snapshots. The old row is null on insert and the new row is null on delete.
{
"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",
"status": "SUCCEEDED",
"currency": "USD",
"tenant_id": "ten_example",
"check_date": null,
"created_at": "2024-11-16T00:59:33.492433+00:00",
"updated_at": "2024-11-17T18:31:43.868708+00:00",
"total_amount": 12500,
"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
},
"old": {
"id": "pym_example",
"status": "SUCCEEDED",
"currency": "USD",
"tenant_id": "ten_example",
"check_date": null,
"created_at": "2024-11-16T00:59:33.492433+00:00",
"updated_at": "2024-11-17T18:30:37.07542+00:00",
"total_amount": 11500,
"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
}
},
"table": "payments",
"webhookSubscriptionId": "whs_example",
"resourceId": "pym_example",
"retryOfId": null,
"retries": [],
"trigger": "update.customer_payment"
}Authorizations
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
Details that are sent over to the webhook
The unique identifier for the event.
Trigger. See the schema for its JSON type and allowed values.
create.customer_payment, update.customer_payment, delete.customer_payment Timestamp when this record was created in Upwell. It is not the business document date and may be much later when historical data is imported. See createdAt definition.
Timestamp of the record's latest recorded update in Upwell. It is not a shipment event, payment date, or document revision date. See updatedAt definition.
Timestamp when the asynchronous job is scheduled to run. It is not a promise of completion at that time. See scheduledAt definition.
Timestamp recorded for processing the event or job. It is separate from the event's underlying business date. See processedAt definition.
Delivery status of the event.
Operation. See the schema for its JSON type and allowed values.
INSERT, UPDATE, DELETE Source table for this delivery, such as carrier_invoices.
The unique identifier for the resource affected by the event.
The unique identifier for the webhook subscription.
The ID of the event being retried, if applicable.
An array of retry attempts for the event.
Show child attributes
Show child attributes
Payload. See the schema for its JSON type and allowed values.
Show child attributes
Show child attributes
Response
Return a 200 status to indicate that the data was received successfully