POST /repos/{owner}/{repo}/hooks

Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can share the same config as long as those webhooks do not have any events that overlap.

Servers

Path parameters

Name Type Required Description
repo String Yes

The name of the repository without the .git extension. The name is not case sensitive.

owner String Yes

The account owner of the repository. The name is not case sensitive.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
name String No

Use web to create a webhook. Default: web. This parameter only accepts the value web.

active Boolean No

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

Default value: true

config Object No

Key/value pairs to provide settings for this webhook.

config.content_type String No

The media type used to serialize the payloads. Supported values include json and form. The default is form.

config.url String No

The URL to which the payloads will be delivered.

config.secret String No

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

config.insecure_ssl No
events[] Array No

Determines what events the hook is triggered for.

Default value: [ "push" ]

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.