Generic Webhook

Create webhook integration

Changed on

Create or replace the outgoing webhook for a project. Kaneo POSTs the selected task events to this URL, signed with the secret when one is set.

post/generic-webhook-integration/project/{projectId}

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/generic-webhook-integration/project/{projectId}
  • Auth
    HTTP bearer

Path parameters

projectIdstring required

Request body

webhookUrlstring required
secretstring

Optional HMAC secret used to sign outgoing deliveries.

dueDateReminderLeadTimeMinutesinteger

Between 5 minutes and 30 days.

Response

The stored integration

idstring required
projectIdstring required
webhookConfiguredboolean required
maskedWebhookUrlstring nullable required
secretConfiguredboolean required
maskedSecretstring nullable required

A preview of the HMAC signing secret used to sign outgoing deliveries.

dueDateReminderLeadTimeMinutesnumber required

How long before a due date the dueDateReminder event fires, in minutes.

isActiveboolean nullable required
createdAtstring date-time required
updatedAtstring date-time required

Changes

  • c9984766c765Revision changes
    • info

      added the non-success response with the status

  • c7b8a842601bRevision changes
    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status