Criar canal de Webhook

dev

https://api-dev.messagefy.io

POST

/api/v1/admin/channel

Requisição

Authorization

Adicionar parâmetro em header

api-key

Exemplo:

api-key: ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Sucesso

application/json

Body

🟠400Sucesso

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api-dev.messagefy.io/api/v1/admin/channel' \
--header 'api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "description": "string",
    "channelType": "http-sender",
    "accountId": "string",
    "parameters": {
        "url": "string",
        "headers": {
            "key": "value"
        }
    }
}'

Response Example

200 - Exemplo 1

{
    "channelId": "019c4799-7a70-7348-97c3-8186d5ca4b9a",
    "feedbackChannelId": null,
    "name": "Canal webhook",
    "description": "Canal webhook - Nova Conta",
    "account": {
        "accountId": "019c478a-9f0d-7a25-b243-30d0ac375eae",
        "name": "Nova Conta Teste5",
        "description": "Nova Conta Teste Fermis",
        "status": {
            "accountStatusId": 1,
            "name": "Created / Inativo",
            "icon": null,
            "description": "Está cadastrado mas não disponível para utilização",
            "canManageChildObjects": true,
            "canSendAndReceiveMessage": false
        },
        "organization": {
            "organizationId": "019bd96a-1fca-753e-a56c-b85f8eb2b1a2",
            "name": "ChatGuru",
            "description": "Organização do ChatGuru",
            "status": {
                "organizationStatusId": 1,
                "name": "Created / Inativo",
                "icon": null,
                "description": "Está cadastrado mas não disponível para utilização",
                "canManageChildObjects": true,
                "canSendAndReceiveMessage": false
            }
        }
    },
    "channelType": {
        "channelTypeId": 4,
        "key": "http-sender",
        "name": "HTTP API & WebHook Sender",
        "description": "",
        "requiredFeedbackChannel": false,
        "canBeFeedbackChannel": true,
        "requireReceiverChannel": false,
        "canBeReceiverChannel": false
    },
    "status": {
        "channelStatusId": 1,
        "name": "Created",
        "icon": null,
        "description": "Está cadastrado mas não disponível para utilização",
        "canSendAndReceiveMessage": false,
        "canConfigure": false
    },
    "provider": {
        "providerId": "019bd96a-1ae8-7e8a-bcbe-f283acc9d8b8",
        "key": "http-sender",
        "name": "http-sender",
        "description": null,
        "icon": null,
        "channelTypeId": 0,
        "channelTypeKey": null,
        "channelTypeName": null,
        "priority": 1,
        "dockerImage": null,
        "platform": null,
        "maxChannelsPerInstance": null,
        "requiresCluster": false,
        "requiresMessageBroker": false,
        "requiresDatabase": false
    },
    "parameters": {
        "url": "https://n8n.fermis.com.br/webhook/messagefy/v2",
        "headers": {
            "foo": "bar",
            "xxx": "1"
        }
    },
    "devices": null
}

Modificado em 2026-02-10 13:01:25

Página anterior

Introdução

Próxima página

Criar canal de Whatsapp