Update

PUT

/api/user/webhook/{id}

Este endpoint permite atualizar os dados de um webhook previamente cadastrado.

✅ Requisitos da Requisição

Método HTTP: PUT

Endpoint: /api/user/webhook/{id}

Content-Type: application/json

Autenticação: api_token

🧠 Header da requisição

Campo	Tipo	Obrigatório	Descrição
`x-api-key`	string	Sim	Token de autenticação API Key
`User-Agent`	AtivoB2B/1.0	Sim

📥 Parâmetros obrigatórios

Na URL (path param):

id — Identificador único do webhook a ser atualizado

No corpo da requisição (body):

{
  "url": "https://meusite.com/novo-endpoint",
  "type": "INFRACTION" OR "TRANSACTION"
}

Exemplo de requisição

Content-Type: application/json
Authorization: api_key

{
  "url": "https://meusite.com/novo-endpoint",
  "type": "TRANSACTION"
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/api/user/webhook/e653ca6c-479c-4aab-8935-6f542e97ead0' \
--header 'x-api-key: {Token}' \
--header 'User-Agent: AtivoB2B/1.0' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "http://webhook.com",
    "type": "INFRACTION"
}'

Response Example

200 - TRANSACTION

{
    "message": "Webhook atualizado com sucesso.",
    "data": {
        "id": "UUID-WEBHOOK",
        "gatewayId": "UUID-GATEWAY",
        "sellerId": "UUID-SELLER",
        "url": "http://webhook.com",
        "type": "TRANSACTION",
        "createdAt": "2025-05-06T20:51:21.993Z",
        "updatedAt": "2025-05-06T20:55:14.621Z",
        "gateway": {
            "id": "UUID-GATEWAY",
            "name": "Gateway Ativo",
            "phone": "(XX) XXXXX-XXXX",
            "email": "gateway@email.com",
            "logoUrl": null,
            "logoName": null,
            "logoKey": null,
            "faviconUrl": null,
            "faviconName": null,
            "faviconKey": null,
            "darkLogoUrl": null,
            "darkLogoName": null,
            "darkLogoKey": null,
            "primaryColor": "#366deb",
            "secondaryColor": "#1b4aa2",
            "tertiaryColor": "#eff3ff",
            "recurrencePercentage": 50,
            "domain": "homologacao.dominio.com",
            "numberCharge": 5,
            "cnpj": "CNPJ-REDACTED",
            "metaTitle": "Meta Title",
            "metaDescription": "Meta Description",
            "companyName": null,
            "origin": null,
            "repassTax": null,
            "status": "ACTIVE",
            "createdAt": "2025-02-03T15:16:48.791Z",
            "updatedAt": "2025-04-29T05:09:44.164Z"
        },
        "seller": {
            "id": "UUID-SELLER",
            "sellerDocument": "CNPJ-REDACTED",
            "fancyName": "Nome Fantasia",
            "sellerName": "Nome da Empresa",
            "sacPhone": "(XX) XXXXX-XXXX",
            "contactPhone": "(XX) XXXXX-XXXX",
            "contactEmail": "contato@email.com",
            "invoiceName": "Nome para Nota Fiscal",
            "averageMonthlyTurnover": 500,
            "averageTicket": 50,
            "typeProduct": "PHYSICAL",
            "soldProducts": "Produtos vendidos",
            "website": "https://empresa.com",
            "zipCode": "XXXXX-XXX",
            "street": "Rua Exemplo",
            "streetNumber": "Nº",
            "neighborhood": "Bairro",
            "addressComplement": null,
            "city": "Cidade",
            "state": "UF",
            "legalRepresentativeName": "Nome do Representante",
            "legalRepresentativeDocument": "CPF-REDACTED",
            "legalRepresentativeBornDate": "1992-03-26T21:58:50.968Z",
            "legalRepresentativePhone": "(XX) XXXXX-XXXX",
            "legalRepresentativeMothersName": "Nome da Mãe",
            "docSocialContractUrl": "https://url-anonimizada.com/doc1.png",
            "docSocialContractName": "doc1.png",
            "docSocialContractKey": "doc1.png",
            "documentCardUrl": "https://url-anonimizada.com/doc2.png",
            "documentCardName": "doc2.png",
            "documentCardKey": "doc2.png",
            "frontDocumentResponsibleUrl": "https://url-anonimizada.com/doc3.png",
            "frontDocumentResponsibleName": "doc3.png",
            "frontDocumentResponsibleKey": "doc3.png",
            "backDocumentResponsibleUrl": "https://url-anonimizada.com/doc4.png",
            "backDocumentResponsibleName": "doc4.png",
            "backDocumentResponsibleKey": "doc4.png",
            "photoWithDocumentUrl": "https://url-anonimizada.com/doc5.png",
            "photoWithDocumentName": "doc5.png",
            "photoWithDocumentKey": "doc5.png",
            "lastSixMonthsRevenueUrl": null,
            "lastSixMonthsRevenueName": null,
            "lastSixMonthsRevenueKey": null,
            "addressProofUrl": null,
            "addressProofName": null,
            "addressProofKey": null,
            "rejectionReason": null,
            "termsAndConditionsAccepetedAt": "2025-03-26T21:51:27.950Z",
            "termsAndConditionsIpAddress": "::ffff:127.0.0.1",
            "status": "REVIEWING",
            "gatewayId": "UUID-GATEWAY",
            "userId": "UUID-USER",
            "createdAt": "2025-03-26T21:51:27.952Z",
            "updatedAt": "2025-04-29T14:21:11.821Z",
            "gateway": {
                "id": "UUID-GATEWAY",
                "name": "Gateway Ativo",
                "phone": "(XX) XXXXX-XXXX",
                "email": "gateway@email.com",
                "logoUrl": null,
                "logoName": null,
                "logoKey": null,
                "faviconUrl": null,
                "faviconName": null,
                "faviconKey": null,
                "darkLogoUrl": null,
                "darkLogoName": null,
                "darkLogoKey": null,
                "primaryColor": "#366deb",
                "secondaryColor": "#1b4aa2",
                "tertiaryColor": "#eff3ff",
                "recurrencePercentage": 50,
                "domain": "homologacao.dominio.com",
                "numberCharge": 5,
                "cnpj": "CNPJ-REDACTED",
                "metaTitle": "Meta Title",
                "metaDescription": "Meta Description",
                "companyName": null,
                "origin": null,
                "repassTax": null,
                "status": "ACTIVE",
                "createdAt": "2025-02-03T15:16:48.791Z",
                "updatedAt": "2025-04-29T05:09:44.164Z"
            }
        }
    },
    "status": 200,
    "error": null
}

Modified at 2025-07-23 19:02:40

Find by ID

Delete

Update

✅ Requisitos da Requisição#

🧠 Header da requisição#

📥 Parâmetros obrigatórios#

Request

Responses

✅ Requisitos da Requisição

🧠 Header da requisição

📥 Parâmetros obrigatórios