QOqovery
Organization Webhook

Create an organization webhook

Create an organization webhook.

post/organization/{organizationId}/webhook

Request

Path parameters

organizationIdstring uuid required

Organization ID

Request body

kind'STANDARD' | 'SLACK' required

Define the type of the webhook. SLACK is a special webhook type to push notifications directly to slack. The target_url must be a Slack compatible endpoint.

target_urlstring required

Set the public HTTP or HTTPS endpoint that will receive the specified events. The target URL must starts with http:// or https://

target_secretstring

Make sure you receive a payload to sign the Qovery request with your secret. Qovery will add a HTTP header Qovery-Signature: <Your Secret> to every webhook requests sent to your target URL.

descriptionstring
enabledboolean

Turn on or off your endpoint.

eventsOrganizationWebhookEventEnum[] required
project_names_filterstring[]

Specify the project names you want to filter to. This webhook will be triggered only if the event is coming from the specified Project IDs. Notes: 1. Wildcard is accepted E.g. product*. 2. Name is case insensitive.

environment_types_filterEnvironmentModeEnum[]

Specify the environment modes you want to filter to. This webhook will be triggered only if the event is coming from an environment with the specified mode.

Example request

{
  "kind": "STANDARD",
  "environment_types_filter": [
    "PRODUCTION"
  ]
}

Response

Organization webhook created

idstring uuid required
created_atstring date-time required
updated_atstring date-time
kind'STANDARD' | 'SLACK'

Define the type of the webhook. SLACK is a special webhook type to push notifications directly to slack. The target_url must be a Slack compatible endpoint.

target_urlstring

Set the public HTTP or HTTPS endpoint that will receive the specified events. The target URL must starts with http:// or https://

target_secret_setboolean
descriptionstring
enabledboolean

Turn on or off your endpoint.

eventsOrganizationWebhookEventEnum[]
project_names_filterstring[]

Specify the project names you want to filter to. This webhook will be triggered only if the event is coming from the specified Project IDs. Notes: 1. Wildcard is accepted E.g. product*. 2. Name is case insensitive.

environment_types_filterEnvironmentModeEnum[]

Specify the environment modes you want to filter to. This webhook will be triggered only if the event is coming from an environment with the specified mode.

Example response

{
  "kind": "STANDARD",
  "environment_types_filter": [
    "PRODUCTION"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.