> For the complete documentation index, see [llms.txt](https://amplify-docs.gitbook.io/amplify/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://amplify-docs.gitbook.io/amplify/english/api/webhooks.md).

# Webhooks

## **Webhooks**

Webhooks are an essential part of the integration process as it is the way your application is notified when different actions are processed within Amplify.

#### Setup

To set up your webhooks, you need to create an [Amplify user](/amplify/english/creating-an-account.md). Once inside your profile, you can configure the URL where we will send the information at: <https://getamplify.app/plataforma/webhooks>

<figure><img src="/files/GCPwVIQ5vP4QO7M2U3v7" alt=""><figcaption></figcaption></figure>

#### **Integration**

The information will be sent via an HTTP POST Request to the URL you have configured in the administration panel.

Here is a basic example of integrating with Node and Express:

```javascript
// routes.js
app.post('/api/amplify/webhook', (req, res) => {
    AmplifyController.webhook(req, res);
})
```

```javascript
// AmplifyController.js
function webhook(req, res) {
  const { body } = req;
  const { topic, transaction } = body;

  console.log('TOPIC', topic)
  console.log('TRANSACTION', transaction);
}
```

#### **Interfaces**

Currently, there are two types of webhooks in Amplify: [**PAYMENT\_INTENT\_CREATED**](/amplify/english/api/webhooks.md#payment_intent_created) and [**PAYMENT\_CREATED**](/amplify/english/api/webhooks.md#payment_created), which have the following interfaces:

#### **PAYMENT\_INTENT\_CREATED**

This webhook is triggered when a user executes a payment intent, which means that the SDK was rendered correctly within your integration.

Response

```json
{
    topic: 'PAYMENT_INTENT_CREATED',
    transaction: {
        paymentIntentId: "123...abc",
        receiverId: "123...abc",
        status: "CREATED",
        metadata: { randomKey: "randomValue"}
    }
}

```

#### **PAYMENT\_CREATED**

This webhook is triggered when a payment is processed successfully.

Response

```json
{
    topic: 'PAYMENT_CREATED',
    transaction: {
        paymentId: "123...abc",
        receiverId: "123...abc",
        amount: "1.0",
        token: "USDC",
        chain: "mumbai",
        metadata: { randomKey: "randomValue"},
        symbol: "USDC"
    }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://amplify-docs.gitbook.io/amplify/english/api/webhooks.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.