PLplugsign

PUT Update webhook

Changed on

Este endpoint permite que você altere o estado de um webhook cadastrado no sistema.

Para isso, é necessário informar o Id do webhook na URL.

put/api/webhooks/{id}

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/webhooks/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

ID do webhook que será atualizado.

Request body

urlstring

O endereço do seu sistema para o qual este webhook deve enviar os dados de resposta.

statusboolean

Status de atividade: true/1 ativo, false/0 inativo (a string "true" responde 422).

type'REQUESTS_EMAIL_OPENED' | 'REQUESTS_UPDATED' | 'REQUESTS_CHAIN_UPDATED' | 'REQUESTS_OPENED' | 'FILE_UPLOADED' | 'FILE_DUPLICATED' | 'FILE_GENERATED_WITH_AI' | 'LOTE_REQUEST_EMAIL_OPENED' | 'LOTE_REQUEST_OPENED' | 'LOTE_REQUEST_CHAIN_UPDATED' | 'LOTE_REQUEST_UPDATED'

Novo tipo do webhook. Não pode ser um tipo já usado por outro webhook da empresa.

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

{
  "message": "Webhook alterado com sucesso!"
}

Changes

  • 3db1513040eaRevision changes
    • breaking

      the request property type changed from integer to boolean

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status