Webhooks de Entrada para Pumble
With the incoming webhooks, you can easily post messages from other apps into Pumble. When you create an incoming webhook, you receive a unique URL by which you can send a JSON payload with the message text.
Criar um webhook de entrada #
Para criar um novo webhook de entrada:
- Clique no nome do seu espaço de trabalho no canto superior esquerdo
- Navegue até Configurações do espaço de trabalho
- Selecione Configurações Gerais no menu suspenso
- Clique na seção Webhooks de entrada na barra lateral
- Clique no botão Novo Webhook no canto superior direito
- Escolha o canal onde seu webhook postará mensagens
- Clique no botão Adicionar Webhooks de entrada para concluir o processo
Quando você cria seu webhook, o editor é aberto automaticamente. Lá você poderá personalizar seu nome, alterar o canal, adicionar uma etiqueta descritiva, personalizar o ícone, e o mais importante, copiar ou gerar seu URL exclusivo.
A taxa limite de webhooks recebidos no Pumble é de um segundo por webhook.
Usar o webhook de entrada para enviar uma mensagem #
Para enviar uma mensagem usando os webhooks de entrada que você acabou de criar, basta fazer uma solicitação HTTP POST para o URL exclusivo que você copiou do editor da webhook.
A carga útil da solicitação deve conter a propriedade de texto e esse texto será postado em um canal específico. Os tipos de conteúdo atualmente suportados são:
- application/json
- application/x-www-form-urlencoded
Aqui está um exemplo de solicitação curl para postar em um canal usando um webhook de entrada usando o tipo de conteúdo application/x-www-form-urlencoded:
curl -X POST \ --location "https://api.pumble.com/workspaces/WORKSPACE-ID/incomingWebhooks/postMessage/WEBHOOK-CODE" \ --data-urlencode "payload={ \"text\": \"This is posted to general and comes from a bot named MyNewWebhook.\" }"
Here is a sample JSON curl request for posting to a channel using an incoming webhook:
curl -X POST \ --location
"https://api.pumble.com/workspaces/WORKSPACE-ID/incomingWebhooks/postMessage/WEBHOOK-CODE" \
-H "Content-Type: application/json" \
-d '{"payload":{"text":"This is posted to general and comes from a bot named MyNewWebhook."}}'
A formatação rich text é suportada para mensagens de webhook.
A formatação de texto pode ser feita usando a seguinte sintaxe em seu arquivo JSON:
"**text**" bold text; "*text*" italic text; "\\`text`" (code)
Usuários, grupos de usuários e canais podem ser mencionados em mensagens de webhook.
Processar os erros #
Se tudo estiver configurado corretamente, você receberá um status HTTP 200 para indicar que seu webhook de entrada funcionou e a mensagem foi enviada com sucesso. Isso pode não ser sempre o caso, e essa ação pode falhar por vários motivos.
Alguns dos erros que você pode encontrar se seus webhooks falharem são:
mensagem: O webhook de entrada está desabilitado. código: 400700 | O webhook foi desativado pelo Administrador do Espaço de trabalho |
mensagem: O webhook de entrada foi removido. código: 400702 | O webhook foi removido pelo Administrador do Espaço de trabalho |
Mensagem: Não encontrado. Código: 404100 | O URL exclusivo não foi encontrado e provavelmente foi regenerado pelo administrador do espaço de trabalho |
mensagem: Você não pode executar esta operação. código: 403200 | Você não tem permissão para postar no canal especificado |
mensagem: O canal está arquivado. código: 400440 | O canal onde os webhooks enviam mensagens está arquivado |
mensagem: Formato de carga útil inválido. código: 400703 | A carga útil da solicitação não está em um dos formatos compatíveis. |