Web フック

import space.jetbrains.api.ExperimentalSpaceSdkApi import space.jetbrains.api.runtime.helpers.ProcessingScope import space.jetbrains.api.runtime.resources.applications import space.jetbrains.api.runtime.types.* @ExperimentalSpaceSdkApi suspend fun ProcessingScope.setupWebhooks() { val spaceClient = clientWithClientCredentials() // Create a webhook for the app val webhook = spaceClient.applications.webhooks.createWebhook( // The application for which the webhook is created application = ApplicationIdentifier.Me, name = "Issue and project events", description = "Track when an issue is created, or a title or a description is updated", // List of HTTP codes treated as successful responses acceptedHttpResponseCodes = listOf(200), // Create subscriptions for specific events. // We recommend creating one subscription per webhook // or several subscriptions for closely related events. subscriptions = listOf(SubscriptionDefinition( name = "Issues created, deleted, or updated", subscription = CustomGenericSubscriptionIn( // The subject of the subscription. // E.g. "Issue", "Project", "Meeting", etc. subjectCode = "Issue", // Event filters. The filters depend on the subject. // E.g. for "Issue", you can subscribe to events in a specific project. filters = listOf(ProjectCommonSubscriptionFilterIn( project = "2PCwjr4gY8Bs" )), // To apply no filters, use emptyList as shown below // filters = emptyList(), eventTypeCodes = listOf( "Issue.Created", "Issue.Deleted", "Issue.TitleUpdated", "Issue.DescriptionUpdated" ) ) )), // Fields to be included in the webhook payload. // By default, only top-level fields are included. payloadFields = { issue{ id() title() description() projectId() archived() } } ) }

Space.processPayload(ktorRequestAdapter, spaceHttpClient, AppInstanceStorage) { payload -> when (payload) { is InitPayload -> { setupWebhooks() // other installation activities // ... } is WebhookRequestPayload -> { // process webhook asynchronously, respond to Space immediately launch { processWebhookEvent(payload) } } } SpaceHttpResponse.RespondWithOk }

POST https://mycompany.jetbrains.space/api/http/applications/me/webhooks Authorization: Bearer here-goes-the-access-token Accept: application/json Content-Type: application/json { "name": "Issue and project events", "description": "Track when an issue is created, or a title or a description is updated", "acceptedHttpResponseCodes": [], "payloadFields": "issue", "subscriptions": [ { "name": "Issues created, deleted, or updated", "subscription": { "subjectCode": "Issue", "filters": [ { "className": "ProjectCommonSubscriptionFilterIn", "project": "2PCwjr4gY8Bs" } ], "eventTypeCodes": [ "Issue.Created", "Issue.Deleted", "Issue.TitleUpdated", "Issue.DescriptionUpdated" ] } } ] }

val webhook = spaceClient.applications.webhooks.createWebhook( // specify a custom endpoint with required macros endpoint = EndpointCreateDTO(" https://myapp.example.com/api/space?issue={{issue}}", false), // other webhook settings // ... )

POST https://mycompany.jetbrains.space/api/http/applications/me/webhooks Authorization: Bearer here-goes-the-access-token Accept: application/json Content-Type: application/json { "name": "Issue and project events", "description": "Track when an issue is created, or a title or a description is updated", "endpoint": { "url": " https://myapp.example.com/api/space?issue={{issue}}", "sslVerification": false }, // other webhook settings // ... }

val webhook = spaceClient.applications.webhooks.createWebhook( // use the Slack message format for the request body payloadTemplate = """ { "blocks": [ { "type": "section", "text": { "type": "mrkdwn", "text": "{{message.author.name}} said \\"{{message.text}}\\"" } } ] } """.trimIndent(), // other webhook settings // ... )

POST https://mycompany.jetbrains.space/api/http/applications/me/webhooks Authorization: Bearer here-goes-the-access-token Accept: application/json Content-Type: application/json { "name": "Message webhook", "description": "Sends a message to a Slack channel", "payloadTemplate": "{\"blocks\": [{\"type\": \"section\",\"text\": {\"type\": \"mrkdwn\",\"text\": \"{{message.author.name}} said \\\\\"{{message.text}}\\\\\"\"}}]}", // other webhook settings // ... }