HUhumanitec
public
Event

Create a new Webhook

Changed on
post/orgs/{orgId}/apps/{appId}/webhooks

Request

  • Base URL
    https://api.humanitec.io
  • URL
    https://api.humanitec.io/orgs/{orgId}/apps/{appId}/webhooks
  • Auth
    none declared

Path parameters

orgIdstring required

The Organization ID.

appIdstring required

The Application ID.

Request body

disabledboolean nullable

Defines whether this job is currently disabled.

headersJSONFieldRequest
idstring

Job ID, unique within the Organization

payloadJSONFieldRequest
secret_headersSecretHeadersRequest

SecretHeaders maps header names to their secret values.

urlstring nullable

The webhook's URL (without protocol, only HTTPS is supported).

Response

A created webhook.

created_atstring

The timestamp of when this Job was created.

created_bystring

The user who created this Job

disabledboolean nullable required

Defines whether this job is currently disabled.

headersJSONFieldResponse required
idstring required

Job ID, unique within the Organization

payloadJSONFieldResponse required
secret_headersstring[] required

The names of the webhook's secret HTTP headers.

urlstring nullable required

The webhook's URL (without protocol, only HTTPS is supported).

Example response

{
  "created_at": "2020-06-22T09:37:23.523Z"
}

Changes

  • 3980a71317caRevision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status