@directus/app 9.13.0 → 9.14.0

package/dist/assets/webhooks.c44db11b.js

@@ -1,147 +0,0 @@
-import{a as o,o as c,b as d,w as a,g as e,e as l,B as s}from"./runtime-core.esm-bundler.e6808e6c.js";const i={class:"markdown-body"},p=e("div",{class:"two-up"},[e("div",{class:"left"},[e("blockquote",null,[e("p",null,"Webhooks are configured within the App (no code required) and send HTTP requests to an external service when a specific event is triggered.")])]),e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#the-webhook-object"},"The Webhook Object")]),e("li",null,[e("a",{href:"#list-webhooks"},"List Webhooks")]),e("li",null,[e("a",{href:"#retrieve-a-webhook"},"Retrieve a Webhook")]),e("li",null,[e("a",{href:"#create-a-webhook"},"Create a Webhook")]),e("li",null,[e("a",{href:"#create-multiple-webhook"},"Create Multiple Webhook")]),e("li",null,[e("a",{href:"#update-a-webhook"},"Update a Webhook")]),e("li",null,[e("a",{href:"#update-multiple-webhooks"},"Update Multiple Webhooks")]),e("li",null,[e("a",{href:"#delete-a-webhook"},"Delete a Webhook")]),e("li",null,[e("a",{href:"#delete-multiple-webhooks"},"Delete Multiple Webhooks")])])])])])],-1),u=e("hr",null,null,-1),_=e("h2",{id:"the-webhook-object"},[s("The Webhook Object "),e("a",{class:"header-anchor",href:"#the-webhook-object"},"#")],-1),b=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"definitions"},[e("p",null,[e("code",null,"id"),s(),e("strong",null,"integer"),e("br"),s(" Primary key of the webhook.")]),e("p",null,[e("code",null,"name"),s(),e("strong",null,"string"),e("br"),s(" Name for the webhook. Shown in the Admin App.")]),e("p",null,[e("code",null,"method"),s(),e("strong",null,"string"),e("br"),s(" HTTP method to use. One of "),e("code",null,"GET"),s(", "),e("code",null,"POST"),s(".")]),e("p",null,[e("code",null,"url"),s(),e("strong",null,"string"),e("br"),s(" Where to send the request too.")]),e("p",null,[e("code",null,"status"),s(),e("strong",null,"string"),e("br"),s(" Status of the webhook. One of "),e("code",null,"active"),s(", "),e("code",null,"inactive"),s(".")]),e("p",null,[e("code",null,"data"),s(),e("strong",null,"boolean"),e("br"),s(" Whether or not to send the event data to the external endpoint.")]),e("p",null,[e("code",null,"actions"),s(),e("strong",null,"csv"),e("br"),s(" When to fire the webhook. Can contain "),e("code",null,"create"),s(", "),e("code",null,"update"),s(", "),e("code",null,"delete"),s(".")]),e("p",null,[e("code",null,"collections"),s(),e("strong",null,"csv"),e("br"),s(" What collections to fire this webhook on.")])])]),e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[s(`{
-	`),e("span",{class:"hljs-attr"},'"data"'),s(`: {
-		`),e("span",{class:"hljs-attr"},'"id"'),s(": "),e("span",{class:"hljs-number"},"1"),s(`,
-		`),e("span",{class:"hljs-attr"},'"name"'),s(": "),e("span",{class:"hljs-string"},'"Build Website"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"method"'),s(": "),e("span",{class:"hljs-string"},'"POST"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"url"'),s(": "),e("span",{class:"hljs-string"},'"https://example.com/"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"status"'),s(": "),e("span",{class:"hljs-string"},'"active"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"data"'),s(": "),e("span",{class:"hljs-literal"},"true"),s(`,
-		`),e("span",{class:"hljs-attr"},'"actions"'),s(": ["),e("span",{class:"hljs-string"},'"create"'),s(", "),e("span",{class:"hljs-string"},'"update"'),s(`],
-		`),e("span",{class:"hljs-attr"},'"collections"'),s(": ["),e("span",{class:"hljs-string"},'"articles"'),s(`]
-	}
-}
-`)])])])],-1),m=e("hr",null,null,-1),g=e("h2",{id:"list-webhooks"},[s("List Webhooks "),e("a",{class:"header-anchor",href:"#list-webhooks"},"#")],-1),k=e("p",null,"List all webhooks that exist in Directus.",-1),w={class:"two-up"},j={class:"left"},f=e("h3",{id:"query-parameters"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),y=s("Supports all "),q=s("global query parameters"),x=s("."),v=e("h3",{id:"returns"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")],-1),E=s("An array of up to "),T=s("limit"),P=s(),S=e("a",{href:"#the-webhook-object"},"webhook objects",-1),R=s(". If no items are available, data will be an empty array."),W={class:"right"},A=e("h3",{id:"rest-api"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),O=e("pre",null,[e("code",null,`GET /webhooks
-SEARCH /webhooks
-`)],-1),C=s("Learn more about SEARCH ->"),L=e("h3",{id:"graphql"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")],-1),D=e("pre",null,[e("code",null,`POST /graphql/system
-`)],-1),Q=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
-	webhooks: [directus_webhooks]
-}
-`)])],-1),B=e("h5",{id:"example"},[s("Example "),e("a",{class:"header-anchor",href:"#example"},"#")],-1),I=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
-	webhooks {
-		url
-		method
-	}
-}
-`)])],-1),M=e("hr",null,null,-1),G=e("h2",{id:"retrieve-a-webhook"},[s("Retrieve a Webhook "),e("a",{class:"header-anchor",href:"#retrieve-a-webhook"},"#")],-1),H=e("p",null,"List an existing webhook by primary key.",-1),U={class:"two-up"},N={class:"left"},V=e("h3",{id:"query-parameters-2"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),z=s("Supports all "),F=s("global query parameters"),J=s("."),K=e("h3",{id:"returns-2"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),X=e("p",null,[s("Returns the requested "),e("a",{href:"#the-webhook-object"},"webhook object"),s(".")],-1),Y=e("div",{class:"right"},[e("h3",{id:"rest-api-2"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`GET /webhooks/:id
-`)]),e("h3",{id:"graphql-2"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-2"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
-	webhooks_by_id(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!): directus_webhooks
-}
-`)])]),e("h5",{id:"examples"},[s("Examples "),e("a",{class:"header-anchor",href:"#examples"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
-	webhooks_by_id(id: `),e("span",{class:"hljs-number"},"15"),s(`) {
-		url
-		actions
-		method
-	}
-}
-`)])])],-1),Z=e("hr",null,null,-1),$=e("h2",{id:"create-a-webhook"},[s("Create a Webhook "),e("a",{class:"header-anchor",href:"#create-a-webhook"},"#")],-1),ee=e("p",null,"Create a new webhook.",-1),se={class:"two-up"},ae={class:"left"},te=e("h3",{id:"query-parameters-3"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),le=s("Supports all "),ne=s("global query parameters"),oe=s("."),re=e("h3",{id:"request-body"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")],-1),he=e("p",null,[s("A partial "),e("a",{href:"#the-webhook-object"},"webhook object"),s(".")],-1),ce=e("p",null,[e("code",null,"name"),s(", "),e("code",null,"actions"),s(", "),e("code",null,"collections"),s(", and "),e("code",null,"url"),s(" are required.")],-1),de=e("h3",{id:"returns-3"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),ie=e("p",null,[s("Returns the "),e("a",{href:"#the-webhook-object"},"webhook object"),s(" for the created webhook.")],-1),pe=e("div",{class:"right"},[e("h3",{id:"rest-api-3"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`POST /webhooks
-`)]),e("h5",{id:"example-2"},[s("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /webhooks"),s(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"name"'),s(": "),e("span",{class:"hljs-string"},'"Example"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"actions"'),s(": ["),e("span",{class:"hljs-string"},'"create"'),s(", "),e("span",{class:"hljs-string"},'"update"'),s(`],
-	`),e("span",{class:"hljs-attr"},'"collections"'),s(": ["),e("span",{class:"hljs-string"},'"articles"'),s(`],
-	`),e("span",{class:"hljs-attr"},'"url"'),s(": "),e("span",{class:"hljs-string"},'"https://example.com"'),s(`
-}
-`)])]),e("h3",{id:"graphql-3"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-3"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
-	create_webhooks_item(data: create_directus_webhooks_input!): directus_webhooks
-}
-`)])]),e("h5",{id:"example-3"},[s("Example "),e("a",{class:"header-anchor",href:"#example-3"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	create_webhooks_item(
-		data: { name: `),e("span",{class:"hljs-string"},'"Example"'),s(", actions: ["),e("span",{class:"hljs-string"},'"create"'),s(", "),e("span",{class:"hljs-string"},'"update"'),s("], collections: ["),e("span",{class:"hljs-string"},'"articles"'),s("], url: "),e("span",{class:"hljs-string"},'"https://example.com"'),s(` }
-	) {
-		id
-		name
-	}
-}
-`)])])],-1),ue=e("hr",null,null,-1),_e=e("h2",{id:"create-multiple-webhook"},[s("Create Multiple Webhook "),e("a",{class:"header-anchor",href:"#create-multiple-webhook"},"#")],-1),be=e("p",null,"Create multiple new webhooks.",-1),me={class:"two-up"},ge={class:"left"},ke=e("h3",{id:"query-parameters-4"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),we=s("Supports all "),je=s("global query parameters"),fe=s("."),ye=e("h3",{id:"request-body-2"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),qe=e("p",null,[s("An array of partial "),e("a",{href:"#the-webhook-object"},"webhook object"),s(".")],-1),xe=e("p",null,[e("code",null,"name"),s(", "),e("code",null,"actions"),s(", "),e("code",null,"collections"),s(", and "),e("code",null,"url"),s(" are required.")],-1),ve=e("h3",{id:"returns-4"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),Ee=e("p",null,[s("Returns the "),e("a",{href:"#the-webhook-object"},"webhook objects"),s(" for the created webhooks.")],-1),Te=e("div",{class:"right"},[e("h3",{id:"rest-api-4"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`POST /webhooks
-`)]),e("h5",{id:"example-4"},[s("Example "),e("a",{class:"header-anchor",href:"#example-4"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /webhooks"),s(`
-
-[
-	{
-		`),e("span",{class:"hljs-attr"},'"name"'),s(": "),e("span",{class:"hljs-string"},'"Example"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"actions"'),s(": ["),e("span",{class:"hljs-string"},'"create"'),s(", "),e("span",{class:"hljs-string"},'"update"'),s(`],
-		`),e("span",{class:"hljs-attr"},'"collections"'),s(": ["),e("span",{class:"hljs-string"},'"articles"'),s(`],
-		`),e("span",{class:"hljs-attr"},'"url"'),s(": "),e("span",{class:"hljs-string"},'"https://example.com"'),s(`
-	},
-	{
-		`),e("span",{class:"hljs-attr"},'"name"'),s(": "),e("span",{class:"hljs-string"},'"Second Example"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"actions"'),s(": ["),e("span",{class:"hljs-string"},'"delete"'),s(`],
-		`),e("span",{class:"hljs-attr"},'"collections"'),s(": ["),e("span",{class:"hljs-string"},'"articles"'),s(`],
-		`),e("span",{class:"hljs-attr"},'"url"'),s(": "),e("span",{class:"hljs-string"},'"https://example.com/on-delete"'),s(`
-	}
-]
-`)])]),e("h3",{id:"graphql-4"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-4"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
-	create_webhooks_items(data: [create_directus_webhooks_input!]!): [directus_webhooks]
-}
-`)])]),e("h5",{id:"example-5"},[s("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	create_webhooks_items(
-		data: [
-			{ name: `),e("span",{class:"hljs-string"},'"Example"'),s(", actions: ["),e("span",{class:"hljs-string"},'"create"'),s(", "),e("span",{class:"hljs-string"},'"update"'),s("], collections: ["),e("span",{class:"hljs-string"},'"articles"'),s("], url: "),e("span",{class:"hljs-string"},'"https://example.com"'),s(` }
-			{ name: `),e("span",{class:"hljs-string"},'"Second Example"'),s(", actions: ["),e("span",{class:"hljs-string"},'"delete"'),s("], collections: ["),e("span",{class:"hljs-string"},'"articles"'),s("], url: "),e("span",{class:"hljs-string"},'"https://example.com/on-delete"'),s(` }
-		]
-	) {
-		id
-		name
-	}
-}
-`)])])],-1),Pe=e("hr",null,null,-1),Se=e("h2",{id:"update-a-webhook"},[s("Update a Webhook "),e("a",{class:"header-anchor",href:"#update-a-webhook"},"#")],-1),Re=e("p",null,"Update an existing webhook.",-1),We={class:"two-up"},Ae={class:"left"},Oe=e("h3",{id:"query-parameters-5"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),Ce=s("Supports all "),Le=s("global query parameters"),De=s("."),Qe=e("h3",{id:"request-body-3"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),Be=e("p",null,[s("A partial "),e("a",{href:"#the-webhook-object"},"webhook object"),s(".")],-1),Ie=e("h3",{id:"returns-5"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),Me=e("p",null,[s("Returns the "),e("a",{href:"#the-webhook-object"},"webhook object"),s(" for the updated webhook.")],-1),Ge=e("div",{class:"right"},[e("h3",{id:"rest-api-5"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`PATCH /webhooks/:id
-`)]),e("h5",{id:"example-6"},[s("Example "),e("a",{class:"header-anchor",href:"#example-6"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /webhooks/15"),s(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"name"'),s(": "),e("span",{class:"hljs-string"},'"Build Website"'),s(`
-}
-`)])]),e("h3",{id:"graphql-5"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-5"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
-	update_webhooks_item(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!, data: update_directus_webhooks_input!): directus_webhooks
-}
-`)])]),e("h5",{id:"example-7"},[s("Example "),e("a",{class:"header-anchor",href:"#example-7"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	update_webhooks_item(id: `),e("span",{class:"hljs-number"},"15"),s(", data: { name: "),e("span",{class:"hljs-string"},'"Build Website"'),s(` }) {
-		name
-	}
-}
-`)])])],-1),He=e("hr",null,null,-1),Ue=e("h2",{id:"update-multiple-webhooks"},[s("Update Multiple Webhooks "),e("a",{class:"header-anchor",href:"#update-multiple-webhooks"},"#")],-1),Ne=e("p",null,"Update multiple existing webhooks.",-1),Ve={class:"two-up"},ze={class:"left"},Fe=e("h3",{id:"query-parameters-6"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),Je=s("Supports all "),Ke=s("global query parameters"),Xe=s("."),Ye=e("h3",{id:"request-body-4"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),Ze=e("div",{class:"definitions"},[e("p",null,[e("code",null,"keys"),s(),e("strong",null,"Required"),e("br"),s(" Array of primary keys of the webhooks you\u2019d like to update.")]),e("p",null,[e("code",null,"data"),s(),e("strong",null,"Required"),e("br"),s(" Any of "),e("a",{href:"#the-webhook-object"},"the webhook object"),s("\u2019s properties.")])],-1),$e=e("h3",{id:"returns-6"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),es=e("p",null,[s("Returns the "),e("a",{href:"#the-webhook-object"},"webhook objects"),s(" for the updated webhooks.")],-1),ss=e("div",{class:"right"},[e("h3",{id:"rest-api-6"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",null,`PATCH /webhooks
-`)]),e("h5",{id:"example-8"},[s("Example "),e("a",{class:"header-anchor",href:"#example-8"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /webhooks"),s(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"keys"'),s(": ["),e("span",{class:"hljs-number"},"15"),s(", "),e("span",{class:"hljs-number"},"41"),s(`],
-	`),e("span",{class:"hljs-attr"},'"data"'),s(`: {
-		`),e("span",{class:"hljs-attr"},'"name"'),s(": "),e("span",{class:"hljs-string"},'"Build Website"'),s(`
-	}
-}
-`)])]),e("h3",{id:"graphql-6"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-6"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
-	update_webhooks_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),s(`!]!, data: update_directus_webhooks_input!): [directus_webhooks]
-}
-`)])]),e("h5",{id:"example-9"},[s("Example "),e("a",{class:"header-anchor",href:"#example-9"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	update_webhooks_items(ids: [`),e("span",{class:"hljs-number"},"15"),s(", "),e("span",{class:"hljs-number"},"41"),s("], data: { name: "),e("span",{class:"hljs-string"},'"Build Website"'),s(` }) {
-		name
-	}
-}
-`)])])],-1),as=e("hr",null,null,-1),ts=e("h2",{id:"delete-a-webhook"},[s("Delete a Webhook "),e("a",{class:"header-anchor",href:"#delete-a-webhook"},"#")],-1),ls=e("p",null,"Delete an existing webhook.",-1),ns=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"returns-7"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-7"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-7"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),e("pre",null,[e("code",null,`DELETE /webhooks/:id
-`)]),e("h5",{id:"example-10"},[s("Example "),e("a",{class:"header-anchor",href:"#example-10"},"#")]),e("pre",null,[e("code",null,`DELETE /webhooks/15
-`)]),e("h3",{id:"graphql-7"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-7"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
-	delete_webhooks_item(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!): delete_one
-}
-`)])]),e("h5",{id:"example-11"},[s("Example "),e("a",{class:"header-anchor",href:"#example-11"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	delete_webhooks_item(id: `),e("span",{class:"hljs-number"},"15"),s(`) {
-		id
-	}
-}
-`)])])])],-1),os=e("hr",null,null,-1),rs=e("h2",{id:"delete-multiple-webhooks"},[s("Delete Multiple Webhooks "),e("a",{class:"header-anchor",href:"#delete-multiple-webhooks"},"#")],-1),hs=e("p",null,"Delete multiple existing webhooks.",-1),cs=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"request-body-5"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-5"},"#")]),e("p",null,"An array of webhook primary keys"),e("h3",{id:"returns-8"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-8"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-8"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),e("pre",null,[e("code",null,`DELETE /webhooks
-`)]),e("h5",{id:"example-12"},[s("Example "),e("a",{class:"header-anchor",href:"#example-12"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// DELETE /webhooks"),s(`
-
-[`),e("span",{class:"hljs-number"},"2"),s(", "),e("span",{class:"hljs-number"},"15"),s(", "),e("span",{class:"hljs-number"},"41"),s(`]
-`)])]),e("h3",{id:"graphql-8"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-8"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
-	delete_webhooks_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),s(`!]!): delete_many
-}
-`)])]),e("h5",{id:"example-13"},[s("Example "),e("a",{class:"header-anchor",href:"#example-13"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	delete_webhooks_items(ids: [`),e("span",{class:"hljs-number"},"2"),s(", "),e("span",{class:"hljs-number"},"15"),s(", "),e("span",{class:"hljs-number"},"41"),s(`]) {
-		ids
-	}
-}
-`)])])])],-1),ds=e("hr",null,null,-1),bs="Webhooks",ms=!1,gs="page-reference",ks={name:"webhooks",setup(is,{expose:r}){const n={title:"Webhooks",modularExtension:!1,pageClass:"page-reference"};return r({frontmatter:n}),(ps,us)=>{const t=o("router-link"),h=o("docs-wrapper");return c(),d(h,{frontmatter:n},{default:a(()=>[e("div",i,[p,u,_,b,m,g,k,e("div",w,[e("div",j,[f,e("p",null,[y,l(t,{to:"/docs/reference/query/"},{default:a(()=>[q]),_:1}),x]),v,e("p",null,[E,l(t,{to:"/docs/reference/query/#limit"},{default:a(()=>[T]),_:1}),P,S,R])]),e("div",W,[A,O,e("p",null,[l(t,{to:"/docs/reference/introduction/#search-http-method"},{default:a(()=>[C]),_:1})]),L,D,Q,B,I])]),M,G,H,e("div",U,[e("div",N,[V,e("p",null,[z,l(t,{to:"/docs/reference/query"},{default:a(()=>[F]),_:1}),J]),K,X]),Y]),Z,$,ee,e("div",se,[e("div",ae,[te,e("p",null,[le,l(t,{to:"/docs/reference/query"},{default:a(()=>[ne]),_:1}),oe]),re,he,ce,de,ie]),pe]),ue,_e,be,e("div",me,[e("div",ge,[ke,e("p",null,[we,l(t,{to:"/docs/reference/query"},{default:a(()=>[je]),_:1}),fe]),ye,qe,xe,ve,Ee]),Te]),Pe,Se,Re,e("div",We,[e("div",Ae,[Oe,e("p",null,[Ce,l(t,{to:"/docs/reference/query"},{default:a(()=>[Le]),_:1}),De]),Qe,Be,Ie,Me]),Ge]),He,Ue,Ne,e("div",Ve,[e("div",ze,[Fe,e("p",null,[Je,l(t,{to:"/docs/reference/query"},{default:a(()=>[Ke]),_:1}),Xe]),Ye,Ze,$e,es]),ss]),as,ts,ls,ns,os,rs,hs,cs,ds])]),_:1})}}};export{ks as default,ms as modularExtension,gs as pageClass,bs as title};

package/dist/assets/webhooks.dcb64844.js

@@ -1 +0,0 @@
-import{a as i,o as s,b as r,w as a,g as e,B as o}from"./runtime-core.esm-bundler.e6808e6c.js";const h=e("div",{class:"markdown-body"},[e("blockquote",null,[e("p",null,[o("Webhooks are configured within the App (no code required) and send HTTP requests when a specific event is triggered. "),e("a",{href:"https://en.wikipedia.org/wiki/Webhook",target:"_blank",rel:"noopener noreferrer"},"Learn more about Webhooks"),o(".")])]),e("h2",{id:"creating-webhooks"},[o("Creating Webhooks "),e("a",{class:"header-anchor",href:"#creating-webhooks"},"#")]),e("ol",null,[e("li",null,[o("Navigate to "),e("strong",null,[o("Settings "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),o(" Webhooks")])]),e("li",null,[o("Click "),e("span",{mi:"",btn:""},"add"),o(" in the header")]),e("li",null,[o("Complete the "),e("strong",null,"other webhook form fields"),o(" outlined below")])]),e("ul",null,[e("li",null,[e("strong",null,"Name"),o(" \u2014 A name to help remember this webhooks purpose")]),e("li",null,[e("strong",null,"Method"),o(" \u2014 Send as either a HTTP "),e("code",null,"GET"),o(" or "),e("code",null,"POST"),o(" request")]),e("li",null,[e("strong",null,"URL"),o(" \u2014 The URL to send the request to")]),e("li",null,[e("strong",null,"Status"),o(" \u2014 Whether the webhook is active (enabled) or inactive (disabled)")]),e("li",null,[e("strong",null,"Data"),o(" \u2014 Whether the event\u2019s data should be sent along with the request")]),e("li",null,[e("strong",null,"Request Headers"),o(" \u2014 Custom headers that will be added to the webhook request")]),e("li",null,[e("strong",null,"Trigger Actions"),o(" \u2014 The specific actions that will trigger the event")]),e("li",null,[e("strong",null,"Trigger Collections"),o(" \u2014 The specific collections for which the above actions will trigger events")])]),e("h2",{id:"disabling-webhooks"},[o("Disabling Webhooks "),e("a",{class:"header-anchor",href:"#disabling-webhooks"},"#")]),e("ol",null,[e("li",null,[o("Navigate to "),e("strong",null,[o("Settings "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),o(" Webhooks "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),o(" [Webhook]")])]),e("li",null,[o("Set the "),e("strong",null,"status field to inactive")])]),e("h2",{id:"deleting-webhooks"},[o("Deleting Webhooks "),e("a",{class:"header-anchor",href:"#deleting-webhooks"},"#")]),e("ol",null,[e("li",null,[o("Navigate to "),e("strong",null,[o("Settings "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),o(" Webhooks "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),o(" [Webhook]")])]),e("li",null,[o("Click "),e("span",{mi:"",btn:"",dngr:""},"delete"),o(" in the header")]),e("li",null,[o("Confirm this decision by clicking "),e("strong",null,"Delete"),o(" in the dialog")])]),e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Irreversible Change"),e("p",null,"This action is permanent and can not be undone. Please proceed with caution.")])],-1),b="Webhooks",k=!1,p={name:"webhooks",setup(c,{expose:t}){const n={title:"Webhooks",modularExtension:!1};return t({frontmatter:n}),(d,u)=>{const l=i("docs-wrapper");return s(),r(l,{frontmatter:n},{default:a(()=>[h]),_:1})}}};export{p as default,k as modularExtension,b as title};