Skip to main content

webhooks

Overview

Namewebhooks
TypeResource
Idgithub.orgs.webhooks

Fields

NameDatatype
idinteger
namestring
urlstring
eventsarray
deliveries_urlstring
typestring
updated_atstring
activeboolean
configobject
created_atstring
ping_urlstring

Methods

NameAccessible byRequired ParamsDescription
get_webhookSELECThook_id, orgReturns a webhook configured in an organization. To get only the webhook config properties, see "Get a webhook configuration for an organization."
list_webhooksSELECTorg
create_webhookINSERTorg, data__config, data__nameHere's how you can create a hook that posts payloads in JSON format:
delete_webhookDELETEhook_id, org
ping_webhookEXEChook_id, orgThis will trigger a ping event to be sent to the hook.
update_webhookEXEChook_id, orgUpdates a webhook configured in an organization. When you update a webhook, the secret will be overwritten. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use "Update a webhook configuration for an organization."