---
updatedAt: 2025-08-08T17:20:55.000Z
agentTools:
  projectIndex: https://docs.staxpayments.com/llms.txt
---

# Merchant Webhooks

You can configure webhooks via the API to be notified about events that happen in your account. Generally, this will be the same result as a GET call performed.

For example the payload of `create_transaction` webhook will have the same payload of [GET transaction/id]()

**Note: This is only for what webhooks are available and how to create them. A service such as webhook.site can be used to create custom webhooks**

| Webhook                      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| create\_customer             | A customer is created. Returns Customer object.                                                                                                                                                                                                                                                                                                                                                                                                                    |
| create\_deposit              | A settlement is processed. The payload of the webhook contains the settlement record. The `external_id` is the connector between the deposit record and the deposit details. This webhook DOES fire in the sandbox, but in the sandbox environment, the external\_id will not match the batch\_id - in the sandbox, you can use this webhook as a notification and build your system to call out to the merchant's deposit APIs to get the latest deposit details. |
| create\_dispute              | A dispute is created. Returns dispute object. Dispute includes the associated transaction\_id.                                                                                                                                                                                                                                                                                                                                                                     |
| create\_invoice              | An invoice is created, which includes invoices created by an invoice schedule. Returns invoice object.                                                                                                                                                                                                                                                                                                                                                             |
| create\_item                 | An item is created.                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| create\_scheduled\_invoice   | An invoice schedule is created. Returns Invoice Schedule.                                                                                                                                                                                                                                                                                                                                                                                                          |
| create\_transaction          | A transaction is created, including those made with Stax.js. Returns transaction object.                                                                                                                                                                                                                                                                                                                                                                           |
| create\_user                 | A user is created.                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| create\_webhook              | A webhook is created.                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| delete\_item                 | An item is deleted.                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| delete\_scheduled\_invoice   | An invoice schedule is deleted.                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| delete\_webhook              | A webhook is deleted.                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| update\_item                 | An item is updated.                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| send\_invoice                | An invoice is sent via email or text.                                                                                                                                                                                                                                                                                                                                                                                                                              |
| set\_branding                | Branding is set.                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| set\_gateway                 | A gateway is set.                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| set\_plan                    | A plan is set.                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| update\_customer             | A customer is updated.                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| update\_dispute              | A dispute is updated. Returns dispute object.                                                                                                                                                                                                                                                                                                                                                                                                                      |
| update\_invoice              | An invoice is updated.                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| update\_scheduled\_invoice   | An invoice schedule is updated.                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| update\_transaction          | A transaction is updated. Returns transaction object.                                                                                                                                                                                                                                                                                                                                                                                                              |
| update\_user                 | A user is updated.                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| update\_payment\_method      | A payment method is updated. With the auto updater, if a payment method is updated by Stax to reflect updated information from the card brands.                                                                                                                                                                                                                                                                                                                    |
| update\_transaction\_settled | An ACH transaction has either settled or not settled. Returns the original transaction object. If the transaction is settled, the `settled_at` date will be populated. If the transaction was clawed back, the transaction's `child_transactions` array will include the associated void transaction.                                                                                                                                                              |
| fee\_statement\_ready        | Receive a notification through the webhook indicating that my statement is ready                                                                                                                                                                                                                                                                                                                                                                                   |

### Merchant Enrollment Webhooks

| Webhook                       | Description                                                  |
| ----------------------------- | ------------------------------------------------------------ |
| update\_underwriting          | Merchant registration's underwriting status(es) are updated. |
| update\_merchant\_status      | Merchant status has changed.                                 |
| update\_electronic\_signature | The merchant signer has signed their merchant application.   |

<br />