Generic Webhook

Create webhook integration

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}

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

Changed in 2 of the 23 revisions of this API.713

  • 08bbb5bedb5d712See the full diff
    • the response's body became nullable

      response-body-became-nullable

    • removed the required property events/taskCommentCreated from the response with the 200 status

      response-required-property-removed

    • removed the required property events/taskCreated from the response with the 200 status

      response-required-property-removed

    • removed the required property events/taskDescriptionChanged from the response with the 200 status

      response-required-property-removed

    • removed the required property events/taskPriorityChanged from the response with the 200 status

      response-required-property-removed

    • removed the required property events/taskStatusChanged from the response with the 200 status

      response-required-property-removed

    • removed the required property events/taskTitleChanged from the response with the 200 status

      response-required-property-removed

    • added the new optional request property dueDateReminderLeadTimeMinutes

      new-optional-request-property

    • added the new optional request property events/dueDateReminder

      new-optional-request-property

    • added the new optional request property events/taskAssigneeChanged

      new-optional-request-property

    • added the new optional request property events/taskDeleted

      new-optional-request-property

    • added the new optional request property events/taskDueDateChanged

      new-optional-request-property

    • added the new optional request property events/taskMoved

      new-optional-request-property

    • added the new optional request property events/taskUnassigned

      new-optional-request-property

    • added the non-success response with the status 400

      response-non-success-status-added

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 403

      response-non-success-status-added

    • added IntegrationEvents subschema #2 to the events response property allOf list for the response status 200

      response-property-all-of-added

    • added the required property dueDateReminderLeadTimeMinutes to the response with the 200 status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added