{"type":"doc","content":[{"type":"heading","attrs":{"level":1},"content":[{"text":"Configuration object","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"name\": \"\",\n \"description\": \"\",\n \"event_id\": \"\",\n \"event_guide_id\": \"\",\n \"hooks\": [\n {\n \"type\": \"\",\n \"method\": \"POST\",\n \"endpoint\": \"\",\n \"origin\": {\n \"method\": \"POST\",\n \"endpoint\": \"https://gql.doo.net\",\n \"body\": \"\"\n }\n }\n ],\n \"authentication\": {\n \"grant_type\": \"client_credentials\",\n \"endpoint\": \"\",\n \"credentials\": {\n \"client_id\": \"doo\",\n \"client_secret\": \"\"\n },\n \"header_format\": \"Authorization\",\n \"header_value_format\": \"Bearer %ACCESS_TOKEN%\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"If the ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" is not protected with OAuth, you can omit the ","type":"text"},{"text":"authentication","type":"text","marks":[{"type":"code"}]},{"text":" object in the configuration object. In this case, doo will send the webhook request without ","type":"text"},{"text":"access_token","type":"text","marks":[{"type":"code"}]},{"text":". See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://viovendi.atlassian.net/wiki/spaces/API/pages/1369361"}},{"text":" for more information.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Parameters","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"In the configuration object, you can see a lot more configurations than described in the table below. We do not recommend changing any parameters that are not listed in the table below.","type":"text"}]}]},{"type":"table","attrs":{"layout":"wide"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[487.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"Yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[487.0]},"content":[{"type":"paragraph","content":[{"text":"Webhook configuration name.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"No","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[487.0]},"content":[{"type":"paragraph","content":[{"text":"Webhook configuration description.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"No","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[487.0]},"content":[{"type":"paragraph","content":[{"text":"doo Event ID. ","type":"text"}]},{"type":"paragraph","content":[{"text":"If specified, the webhook configuration will be attached only to the specified event. ","type":"text"}]},{"type":"paragraph","content":[{"text":"If neither ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" nor ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" is specified, the webhook configuration will be attached to the whole organization.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"No","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[487.0]},"content":[{"type":"paragraph","content":[{"text":"doo Event Guide ID.","type":"text"}]},{"type":"paragraph","content":[{"text":"If specified, the webhook configuration will be attached to all the events created with the specified event guide.","type":"text"}]},{"type":"paragraph","content":[{"text":"If neither ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" nor ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" is specified, the webhook configuration will be attached to the whole organization.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"Yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[487.0]},"content":[{"type":"paragraph","content":[{"text":"Webhook type name from ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://viovendi.atlassian.net/wiki/spaces/API/pages/2800549949"}},{"text":" without ","type":"text"},{"text":"on_","type":"text","marks":[{"type":"code"}]},{"text":" preffix.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"Yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[487.0]},"content":[{"type":"paragraph","content":[{"text":"External API endpoint where doo sends the webhook payload for the specified webhook type.","type":"text"}]},{"type":"paragraph","content":[{"text":"See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://viovendi.atlassian.net/wiki/spaces/API/pages/1369361"}},{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"Yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[487.0]},"content":[{"type":"paragraph","content":[{"text":"GraphQL query which specifies the webhook payload structure.","type":"text"}]},{"type":"paragraph","content":[{"text":"See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://viovendi.atlassian.net/wiki/spaces/API/pages/3014492239"}},{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"Yes, if ","type":"text"},{"text":"authentication","type":"text","marks":[{"type":"code"}]},{"text":" object does exist in the configuration object","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[487.0]},"content":[{"type":"paragraph","content":[{"text":"External authorization OAuth API endpoint where doo can retrieve the ","type":"text"},{"text":"access_token","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://viovendi.atlassian.net/wiki/spaces/API/pages/1369361"}},{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"Yes, if ","type":"text"},{"text":"authentication","type":"text","marks":[{"type":"code"}]},{"text":" object does exist in the configuration object","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[487.0]},"content":[{"type":"paragraph","content":[{"text":"A valid OAuth Client Secret which doo will use to retrieve the","type":"text"},{"text":"access_token","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Example","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"cf2a0e0a-aad6-48b4-bb62-ddf264e820e0"}}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"name\": \"Test webhook\",\n \"description\": \"Event creation and updates webhook subscription\",\n \"hooks\": [\n {\n \"type\": \"event_created\",\n \"method\": \"POST\",\n \"endpoint\": \"https://company.com/receive-doo-webhooks\",\n \"origin\": {\n \"method\": \"POST\",\n \"endpoint\": \"https://gql.doo.net\",\n \"body\": \"{\\\"operationName\\\":null,\\\"variables\\\":{\\\"eventId\\\":\\\"%EVENT_ID%\\\"},\\\"query\\\":\\\"query ($eventId: ID!) {event(id: $eventId) { id title }}\\\"}\"\n }\n },\n {\n \"type\": \"event_updated\",\n \"method\": \"POST\",\n \"endpoint\": \"https://company.com/receive-doo-webhooks\",\n \"origin\": {\n \"method\": \"POST\",\n \"endpoint\": \"https://gql.doo.net\",\n \"body\": \"{\\\"operationName\\\":null,\\\"variables\\\":{\\\"eventId\\\":\\\"%EVENT_ID%\\\"},\\\"query\\\":\\\"query ($eventId: ID!) {event(id: $eventId) { id title }}\\\"}\"\n }\n }\n ],\n \"authentication\": {\n \"grant_type\": \"client_credentials\",\n \"endpoint\": \"https://company.com/authorize-doo-webhooks\",\n \"credentials\": {\n \"client_id\": \"doo\",\n \"client_secret\": \"super-strong-secret\"\n },\n \"header_format\": \"Authorization\",\n \"header_value_format\": \"Bearer %ACCESS_TOKEN%\"\n }\n}","type":"text"}]}],"version":1}

Browser not supported