Webhook

Developing

PUT

/api/v1/webhooks/endpoints/{endpoint_id}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Example

{
    "name": "Test Webhook",
    "url": "http://192.168.1.57:8080",
    "events":[

        "stock_quantity_updated",
        "stock_critical_level",
        "stock_empty",
        "stock_available",
        "stock_replenished",

        "order_created",
        "order_confirmed",
        "order_updated",
        "order_shipped",
        "order_delivered",
        "order_cancelled",
        "order_completed",

        "product_created",
        "product_updated"
    ],
    
    // Certificado Privado para assinatura de mensagns
    // A chave privada do usuário é armazenada de forma segura, ofuscada com criptografia AES-256 e protegida por uma senha derivada via PBKDF2 com salt único.

    "secret": "LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1JSUV2Z0lCQURBTkJna3Foa2lHOXcwQkFRRUZBQVNDQktnd2dnU2tBZ0VBQW9JQkFRQy8ycTRvSmRNK2ZJNjcKVndhVE55SFpXcWhwRExDczdKUlRrUE1BTE84SWZWbzY1VW53YUhOVDY1ZDdrclVNczZldnVTRUs5SU5oK1FnTgpxOCtVWElTNnNoT1krdy9rYkN0M0w4YkEzZ3RScFFPd21zd2ZtcktCczNNcEdMTkQ0aWpkU2xCdytQeHJFaHRrCmJlZGd6aEF1S3dwTU1XNDBkaE03Zy83blFKem8yU0IyY3pnTXZ5V08yd3B3cWRuVkZXa1JFOE04dklTaUZObkkKakMrUzVCL1pCRStRQS9ZS2pFY2V6Ymg5RllqZ1ZzRmhBU1V0SHdQNDFUdFYvYmdkeUE4Q3JBdGZkMGFVa1I0cQpUWEM4ZVk5bHZIR3FCMTFwSERWTUJFWWltcjZET1Y0K0JIZVBpYXVwSGF6ZHZkYXRCM2dnZ1VZOEpDbW96a2hnCk1YbXJWUmJoQWdNQkFBRUNnZ0VBQlc5TDdLNDVvRFVHRkErQWk2NE5vdXNiQnpMSlZIUzFOUExQdDJzT2NHYWcKcGpkMWt6NWFPZi9jQUMrbE9sRmlpQ3RONE5JUllMYWR3RWxrTFhjN2VWQnZGcS9TQU80Qmd6UlN4SWJsdWkvYQovV2M5TGc0RFRZSklXbHN0Uk5pRXdOUUltRkt0VDlrbzluelloNWordzFnTHlDSEVWZThjVjF6RFhVaXF5VHZFCnphUzhCS2ErTWIrOTlEQjVqSWR5ekgxUUZJNjdQOUVFUC9PaTgyRDRzemxtVWZ2ZVhuK1BlUXBKU2t2Z2hyeXoKY3ZKOFl1Q1E0ckxOVHhndXdjSjBqZXByL250UUtFSFhUMXptcVN3elRNalJNQzNvNThPYWFzU2tMYnJXM3NBMApFSjJPNXRqOVN5YWo3OFlGZWo4aUttVHdRVE9BYnYvdlkwemVoTjR4Z3dLQmdRRGY4RVNYbEZBdlBEc1czUnNpCnNxL0pHMVhmRXY2azZ1UWcydmgwWCsya2p6VFdhYTZ0bjBpTTgzbUMxaytSZjkzd3VoQlBSZnByak9ubU4xMGoKY0NhNTVQTVNBRTJ1UnJDdWthWS91UnhabE5uSENpYXNJZDVQS3FzQ1hmT0JzS1pBbGJCZU9YQlNGSGdoRWlSdAo4cnpCK3Z1TTFtbmRaRzd6bjFIT1N1MUdKd0tCZ1FEYlVuZDdRVDFwSHRxOE9MSDd2R3pBQjJCMVloanBGZlNwCkV4bVNHc1h1bkF6bUdocDl6V0xCNEorcE1mUkJFTHpvc2JTWlVVSkdlZU8vVCt6czhEUWxiQy85TFZjbVUwRTYKYVB0TnIxWkFGMVZDbFlXcnZSSXBYd3hUeUJrZnlKRTE4NnVvd2txeVM4ZGpEejN6YVhpQkgxOHBqZ2E5MG84ZwpkWXhXWnJnbnR3S0JnQkx5ZUVzKzhEM2U0YjBBZmpCRVlCMHE0K3dZNWxTN3p3dDhtM0wxUHQwaWhMenplaVVVCmlnWHEvOGZ6TEE1S2ZGUEcybVJxcmxKMVBNRU94Q0dnZHBaWjZic0hMWXRtVGNLbmJpS01IZnJ5WGk2NkRDV2EKUS8zOHhUVlJENjVVYk95Zi9ha3JRUGFnNXIwZGxObDhwVDNnWjNJMkhnVHVYM2piYlFlQVRXMFhBb0dCQUtnVQpkaTdHVzdyaEEzNzE4Q2pkU1hhTThMWmszSFJjK0NoTzArenRpYjBJYUxZN1VRd1NSOW9QUEN6ZGRMUWNrTG0vCjNva1ZCamFlbVJSM3V6b0dCK0NhSGRqb1UzNnlsUzJmWU9BelBHVlh2R2FQMG1aQU90ZnIyTFdvaHVDZHcvTlYKNzdzZ1UwQjY1SzRjOHp4Rkd5M1JqZ3Q1cGQ3NXEraVRUVjYxei9IWEFvR0JBSkFJdVNDNG1CRU0xdFF5MUNsbQpPaEZyclI4S0NLVWhqZHNuRVV3bTFuSmpQTUNNc1RqcFI5NDhTWENKZExOWDJPYnJqQW11aW93NlBzdlNrVDd3CjNDc0FaR3lIQ1VweHlRM2gvZHRQZFZaUVBYTVJkM2ttNDVVZG15L0hOWVplZkFTVmV6emNFOUxKbEtwaklDN3oKNEVqc2JranNib1BsempRMU80YkRDSTFjCi0tLS0tRU5EIFBSSVZBVEUgS0VZLS0tLS0="
}

Responses

🟢200OK

application/json

Body

Example

{
    "success": true,
    "message": "Endpoint de webhook atualizado com sucesso",
    "data": {
        "id": "a19a9238-500b-4584-bee6-3cfbb8e18719",
        "url": "http://192.168.1.57:8081",
        "events": [
            "stock_quantity_updated",
            "stock_critical_level",
            "stock_empty",
            "stock_available",
            "stock_replenished",
            "order_created",
            "order_confirmed",
            "order_updated",
            "order_cancelled",
            "order_completed",
            "product_created",
            "product_updated"
        ],
        "events_labels": [
            {
                "value": "stock_quantity_updated",
                "label": "Quantidade de estoque alterada",
                "category": "stock"
            },
            {
                "value": "stock_critical_level",
                "label": "Estoque em nível crítico",
                "category": "stock"
            },
            {
                "value": "stock_empty",
                "label": "Estoque zerado",
                "category": "stock"
            },
            {
                "value": "stock_available",
                "label": "Estoque ficou disponível",
                "category": "stock"
            },
            {
                "value": "stock_replenished",
                "label": "Estoque reabastecido",
                "category": "stock"
            },
            {
                "value": "order_created",
                "label": "Pedido criado",
                "category": "order"
            },
            {
                "value": "order_confirmed",
                "label": "Pedido confirmado",
                "category": "order"
            },
            {
                "value": "order_updated",
                "label": "Pedido atualizado",
                "category": "order"
            },
            {
                "value": "order_cancelled",
                "label": "Pedido cancelado",
                "category": "order"
            },
            {
                "value": "order_completed",
                "label": "Pedido completado",
                "category": "order"
            },
            {
                "value": "product_created",
                "label": "Produto criado",
                "category": "product"
            },
            {
                "value": "product_updated",
                "label": "Produto atualizado",
                "category": "product"
            }
        ],
        "is_active": true,
        "has_secret": false,
        "headers_count": 2,
        "created_at": "2025-07-21T21:43:05.000000Z",
        "updated_at": "2025-07-21T21:46:43.000000Z",
        "stats": {
            "total_calls": 0,
            "successful_calls": 0,
            "failed_calls": 0
        }
    }
}

Webhook