Create Webhook - Blink Documentation

Basic Parameters
Advanced Parameters
Example Output
Workflow Library Example

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.

External DocumentationTo learn more, visit the GitHub documentation.

Basic Parameters

Parameter	Description
Config Content Type	The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
Config Secret	If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for.
Events	Determines what events the hook is triggered for.
Name	This parameter only accepts the value `web`.
Owner	The organization or person who owns the repository. github.com//
Payload URL	The URL to which the payloads will be delivered.
Repo	Name of the repository owned by the owner. github.com//

Advanced Parameters

Parameter	Description
Active	Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.

Example Output

{
	"value": {
		"active": true,
		"config": {
			"content_type": "json",
			"insecure_ssl": "0",
			"url": "https://example.com/webhook"
		},
		"created_at": "2019-06-03T00:57:16Z",
		"deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries",
		"events": [
			"push",
			"pull_request"
		],
		"id": 12345678,
		"last_response": {
			"code": null,
			"message": null,
			"status": "unused"
		},
		"name": "web",
		"ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings",
		"test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test",
		"type": "Repository",
		"updated_at": "2019-06-03T00:57:16Z",
		"url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678"
	}
}