Criar uma Subscription

POST

https://api.deskfy.io/WebhookSubscriptions

Última modificação:2026-02-13 18:25:02

Registra um novo webhook. Quando os eventos configurados ocorrerem,
o Deskfy enviará uma requisição POST para a URL informada.

Requisição

Authorization

Adicionar parâmetro em header

x-api-key

Exemplo:

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

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK

application/json

Subscription criada com sucesso

Body

🟠400Solicitação incorreta

🟠401Não autenticado

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.deskfy.io/WebhookSubscriptions' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https://sua-aplicacao.com/webhook/deskfy",
    "headers": {
        "Authorization": "Bearer seu-token-secreto",
        "X-App-Signature": "assinatura-opcional",
        "X-Custom-Header": "header-customizado"
    },
    "events": [
        "UPDATE_TASK",
        "NEW_TASK",
        "NEW_TASK_COMMENT",
        "UPDATE_BRIEFING"
    ]
}'

Response Example

{
    "message": "Subscription created successfully",
    "data": {
        "subscriptionCode": "00000000-0000-0000-0000-000000000000"
    }
}

Modificado em 2026-02-13 18:25:02

Página anterior

Detalhes de uma solicitação

Próxima página

Listar suas Subscriptions