Skip to main content

nominal_api/conjure/endpoints/scout/webhook/template/
webhook_template_service.rs

1use conjure_http::endpoint;
2#[conjure_http::conjure_endpoints(
3    name = "WebhookTemplateService",
4    use_legacy_error_serialization
5)]
6pub trait WebhookTemplateService {
7    /// Validates a Handlebars webhook template and returns the evaluated payload.
8    /// Checks for template syntax errors and validates that the result is valid JSON.
9    #[endpoint(
10        method = POST,
11        path = "/scout/v1/webhook-templates/validate",
12        name = "validateTemplate",
13        produces = conjure_http::server::StdResponseSerializer
14    )]
15    fn validate_template(
16        &self,
17        #[auth]
18        auth_: conjure_object::BearerToken,
19        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
20        request: super::super::super::super::super::objects::scout::webhook::template::api::ValidateTemplateRequest,
21    ) -> Result<
22        super::super::super::super::super::objects::scout::webhook::template::api::ValidationResult,
23        conjure_http::private::Error,
24    >;
25    /// Sends a test webhook using the specified integration and template.
26    /// This allows users to verify their webhook configuration before using it in procedures.
27    #[endpoint(
28        method = POST,
29        path = "/scout/v1/webhook-templates/test",
30        name = "testWebhook",
31        produces = conjure_http::server::StdResponseSerializer
32    )]
33    fn test_webhook(
34        &self,
35        #[auth]
36        auth_: conjure_object::BearerToken,
37        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
38        request: super::super::super::super::super::objects::scout::webhook::template::api::TestWebhookRequest,
39    ) -> Result<
40        super::super::super::super::super::objects::scout::webhook::template::api::TestWebhookResponse,
41        conjure_http::private::Error,
42    >;
43}
44#[conjure_http::conjure_endpoints(
45    name = "WebhookTemplateService",
46    use_legacy_error_serialization
47)]
48pub trait AsyncWebhookTemplateService {
49    /// Validates a Handlebars webhook template and returns the evaluated payload.
50    /// Checks for template syntax errors and validates that the result is valid JSON.
51    #[endpoint(
52        method = POST,
53        path = "/scout/v1/webhook-templates/validate",
54        name = "validateTemplate",
55        produces = conjure_http::server::StdResponseSerializer
56    )]
57    async fn validate_template(
58        &self,
59        #[auth]
60        auth_: conjure_object::BearerToken,
61        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
62        request: super::super::super::super::super::objects::scout::webhook::template::api::ValidateTemplateRequest,
63    ) -> Result<
64        super::super::super::super::super::objects::scout::webhook::template::api::ValidationResult,
65        conjure_http::private::Error,
66    >;
67    /// Sends a test webhook using the specified integration and template.
68    /// This allows users to verify their webhook configuration before using it in procedures.
69    #[endpoint(
70        method = POST,
71        path = "/scout/v1/webhook-templates/test",
72        name = "testWebhook",
73        produces = conjure_http::server::StdResponseSerializer
74    )]
75    async fn test_webhook(
76        &self,
77        #[auth]
78        auth_: conjure_object::BearerToken,
79        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
80        request: super::super::super::super::super::objects::scout::webhook::template::api::TestWebhookRequest,
81    ) -> Result<
82        super::super::super::super::super::objects::scout::webhook::template::api::TestWebhookResponse,
83        conjure_http::private::Error,
84    >;
85}
86#[conjure_http::conjure_endpoints(
87    name = "WebhookTemplateService",
88    use_legacy_error_serialization,
89    local
90)]
91pub trait LocalAsyncWebhookTemplateService {
92    /// Validates a Handlebars webhook template and returns the evaluated payload.
93    /// Checks for template syntax errors and validates that the result is valid JSON.
94    #[endpoint(
95        method = POST,
96        path = "/scout/v1/webhook-templates/validate",
97        name = "validateTemplate",
98        produces = conjure_http::server::StdResponseSerializer
99    )]
100    async fn validate_template(
101        &self,
102        #[auth]
103        auth_: conjure_object::BearerToken,
104        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
105        request: super::super::super::super::super::objects::scout::webhook::template::api::ValidateTemplateRequest,
106    ) -> Result<
107        super::super::super::super::super::objects::scout::webhook::template::api::ValidationResult,
108        conjure_http::private::Error,
109    >;
110    /// Sends a test webhook using the specified integration and template.
111    /// This allows users to verify their webhook configuration before using it in procedures.
112    #[endpoint(
113        method = POST,
114        path = "/scout/v1/webhook-templates/test",
115        name = "testWebhook",
116        produces = conjure_http::server::StdResponseSerializer
117    )]
118    async fn test_webhook(
119        &self,
120        #[auth]
121        auth_: conjure_object::BearerToken,
122        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
123        request: super::super::super::super::super::objects::scout::webhook::template::api::TestWebhookRequest,
124    ) -> Result<
125        super::super::super::super::super::objects::scout::webhook::template::api::TestWebhookResponse,
126        conjure_http::private::Error,
127    >;
128}