Update notification integration | Integrations | Northflank API docs
v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Integrations /

Update notification integration

Updates a notification integration

Required permission

Account > Team > Notifications > Manage

Path parameters

    • notificationId

      string required

      ID of the notification integration

Request body

  • {object}

    • name

      string

      The name of the notification integration.

      min length
      3
      max length
      39
      pattern
      ^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$

    • webhook

      string

      The URL where webhooks will be sent.

    • secret

      string

      An optional secret that will be sent in the webhook header for verification. Supports RAW_WEBHOOK only.

    • restricted

      boolean

      Should notifications be sent only for specific projects?

    • projects

      [array]

      An array of projects that notifications will be sent for.

      • string
        pattern
        ^[A-Za-z0-9-]+$

    • events

      {object}

      Which events should notifications be sent for?

      • trigger:service:autoscaling:event

        boolean

      • trigger:service:deployment:status-update

        boolean

      • trigger:addon-backup:start

        boolean

      • trigger:addon-backup:success

        boolean

      • trigger:addon-backup:failure

        boolean

      • trigger:addon-backup:abort

        boolean

      • trigger:build:start

        boolean

      • trigger:build:success

        boolean

      • trigger:build:failure

        boolean

      • trigger:build:abort

        boolean

      • trigger:job-run:start

        boolean

      • trigger:job-run:success

        boolean

      • trigger:job-run:failure

        boolean

      • trigger:job-run:abort

        boolean

      • trigger:job-run:terminate

        boolean

      • trigger:release-flow-template-run:start

        boolean

      • trigger:release-flow-template-run:update

        boolean

      • trigger:release-flow-template-run:success

        boolean

      • trigger:release-flow-template-run:failure

        boolean

      • trigger:release-flow-template-run:aborted

        boolean

      • trigger:template-run:queued

        boolean

      • trigger:template-run:start

        boolean

      • trigger:template-run:update

        boolean

      • trigger:template-run:success

        boolean

      • trigger:template-run:failure

        boolean

      • trigger:resource:certificate-success

        boolean

      • trigger:resource:certificate-final-failure

        boolean

      • trigger:cdn:action-success

        boolean

      • trigger:cdn:action-failure

        boolean

      • trigger:cdn:action-delay

        boolean

      • trigger:log-sink:paused

        boolean

      • trigger:billing:billing-alert-exceeded

        boolean

      • trigger:billing:invoice-payment-action-required

        boolean

      • trigger:billing:invoice-payment-failed

        boolean

      • trigger:billing:invoice-paid

        boolean

      • trigger:billing:invoice-carried-over

        boolean

      • trigger:infrastructure:service:container-crash

        boolean

      • trigger:infrastructure:service:container-eviction

        boolean

      • trigger:infrastructure:addon:container-crash

        boolean

      • trigger:infrastructure:addon:container-eviction

        boolean

      • trigger:infrastructure:job:container-crash

        boolean

      • trigger:infrastructure:job:container-eviction

        boolean

      • trigger:infrastructure:service:container-cpuSpike90

        boolean

      • trigger:infrastructure:service:container-cpuSustained90

        boolean

      • trigger:infrastructure:job:container-cpuSpike90

        boolean

      • trigger:infrastructure:job:container-cpuSustained90

        boolean

      • trigger:infrastructure:addon:container-cpuSpike90

        boolean

      • trigger:infrastructure:addon:container-cpuSustained90

        boolean

      • trigger:infrastructure:service:container-memorySpike90

        boolean

      • trigger:infrastructure:service:container-memorySustained90

        boolean

      • trigger:infrastructure:job:container-memorySpike90

        boolean

      • trigger:infrastructure:job:container-memorySustained90

        boolean

      • trigger:infrastructure:addon-volume:usage-75-exceeded

        boolean

      • trigger:infrastructure:addon-volume:usage-90-exceeded

        boolean

      • trigger:infrastructure:platform-volume:usage-75-exceeded

        boolean

      • trigger:infrastructure:platform-volume:usage-90-exceeded

        boolean

      • trigger:infrastructure:cluster:controller

        boolean

      • trigger:infrastructure:cluster:scheduling

        boolean

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

    API
    CLI
    JS Client

    POST /v1/integrations/notifications/{notificationId}

    Example request

    Request body
    curl
    curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"name":"Example Notification","webhook":"https://example.com/webhooks","restricted":true,"projects":["default-project"],"events":{"trigger:service:autoscaling:event":true,"trigger:service:deployment:status-update":true,"trigger:addon-backup:start":true,"trigger:addon-backup:success":true,"trigger:addon-backup:failure":true,"trigger:addon-backup:abort":true,"trigger:build:start":true,"trigger:build:success":true,"trigger:build:failure":true,"trigger:build:abort":true,"trigger:job-run:start":true,"trigger:job-run:success":true,"trigger:job-run:failure":true,"trigger:job-run:abort":true,"trigger:job-run:terminate":true,"trigger:release-flow-template-run:start":true,"trigger:release-flow-template-run:update":true,"trigger:release-flow-template-run:success":true,"trigger:release-flow-template-run:failure":true,"trigger:release-flow-template-run:aborted":true,"trigger:template-run:queued":true,"trigger:template-run:start":true,"trigger:template-run:update":true,"trigger:template-run:success":true,"trigger:template-run:failure":true,"trigger:resource:certificate-success":true,"trigger:resource:certificate-final-failure":true,"trigger:cdn:action-success":true,"trigger:cdn:action-failure":true,"trigger:cdn:action-delay":true,"trigger:log-sink:paused":true,"trigger:billing:billing-alert-exceeded":true,"trigger:billing:invoice-payment-action-required":true,"trigger:billing:invoice-payment-failed":true,"trigger:billing:invoice-paid":true,"trigger:billing:invoice-carried-over":true,"trigger:infrastructure:service:container-crash":true,"trigger:infrastructure:service:container-eviction":true,"trigger:infrastructure:addon:container-crash":true,"trigger:infrastructure:addon:container-eviction":true,"trigger:infrastructure:job:container-crash":true,"trigger:infrastructure:job:container-eviction":true,"trigger:infrastructure:service:container-cpuSpike90":true,"trigger:infrastructure:service:container-cpuSustained90":true,"trigger:infrastructure:job:container-cpuSpike90":true,"trigger:infrastructure:job:container-cpuSustained90":true,"trigger:infrastructure:addon:container-cpuSpike90":true,"trigger:infrastructure:addon:container-cpuSustained90":true,"trigger:infrastructure:service:container-memorySpike90":true,"trigger:infrastructure:service:container-memorySustained90":true,"trigger:infrastructure:job:container-memorySpike90":true,"trigger:infrastructure:job:container-memorySustained90":true,"trigger:infrastructure:addon-volume:usage-75-exceeded":true,"trigger:infrastructure:addon-volume:usage-90-exceeded":true,"trigger:infrastructure:platform-volume:usage-75-exceeded":true,"trigger:infrastructure:platform-volume:usage-90-exceeded":true,"trigger:infrastructure:cluster:controller":true,"trigger:infrastructure:cluster:scheduling":true}}' \
  https://api.northflank.com/v1/integrations/notifications/{notificationId}

    Example response

    200 OK

    The operation was performed successfully.

    JSON

    {
  "data": {}
}

    © 2024 Northflank Ltd. All rights reserved.

    northflank.comTermsPrivacyfeedback@northflank.com