POST /orgs/{org}/hooks

Create a hook that posts payloads in JSON format.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

Servers

https://api.github.com

Path parameters

Name	Type	Required	Description
`org`	String	Yes	The organization name. 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	Yes	Must be passed as "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	Yes	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.username`	String	No
`config.url`	String	Yes	The URL to which the payloads will be delivered.
`config.password`	String	No
`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. Set to `["*"]` to receive all possible events. Default value: [ "push" ]

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.