Skip to content
GitmoapAPIBeta
Schema

CreateWebhookRequest

Creates a webhook that is called when the chosen events happen.

Shape

  • eventsarray of WebhookEventType: one of push | merge_request | tag_push | issue | accessThe events that trigger a delivery.
  • secretstring · passwordThe secret each delivery is signed with, so your endpoint can check it came from gitmoap. Stored encrypted and never returned.
  • urlWebhookUrl (string)
  • activebooleanoptionalWhether deliveries are sent. Defaults to true.
  • namestring or nulloptional

Example

Synthesized example
{
"events": [
"push",
"push"
],
"secret": "secret-85a4",
"url": "https://gitmoap.example/acme/383a9f21",
"active": true,
"name": "payments-api"
}

Graph

Used inside

No schema contains this one.

Contains

No named schema inside.

Used by

Returned by 0 operations

No operation returns it directly.