PLplugsign

PUT Update Webhook Headers

Changed on

Este endpoint define o header personalizado que a PlugSign envia em todas as notificações de webhook da sua empresa (por exemplo, um token de autenticação do seu endpoint).

Os dois campos precisam estar presentes no corpo. Para remover o header, envie os dois vazios: a resposta é 200 com a mensagem de remoção.

put/api/webhooks/headers

Request

  • Base URL
    https://app.plugsign.com.br
  • Auth
    API key in header Authorization

Request body

header_namestring required

Nome do header. Precisa estar presente no corpo; vazio junto com header_value vazio remove o header.

header_valuestring required

Valor do header. Precisa estar presente no corpo; vazio junto com header_name vazio remove o header.

Response

200

statusstring required

Status de confirmação retornada pela API.

messagestring

Mensagem de confirmação retornada pela API.

actionstring

Presente apenas na remoção do header (valor fixo reload()); pode ser ignorado.

Changes

  • 3db1513040eaRevision changes
    • breaking

      the request property became required

    • breaking

      the request property became required

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status