Skip to content
This repository has been archived by the owner on Jul 13, 2024. It is now read-only.

Create How to Use #1

Open
Subtixx opened this issue Apr 27, 2023 · 0 comments
Open

Create How to Use #1

Subtixx opened this issue Apr 27, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Subtixx
Copy link
Collaborator

Subtixx commented Apr 27, 2023

Webhook needs to be in this specified format currently:

{
  "data": [
    {
      "webhook": {
        "id": "3J2Fyl3TynQQ",
        "archived": false,
        "app": {
          "id": "2dd4D44JcWM9"
        },
        "subscriptions": [
          {
            "id": "1hMsjB0vgbH4",
            "name": "Issues",
            "enabled": true,
            "subscription": {
              "subjectCode": "Issue",
              "filters": [
                {
                  "className": "ProjectCommonSubscriptionFilter",
                  "project": {
                    "id": "2Ektp30zL4Ai"
                  }
                }
              ],
              "eventTypeCodes": [
                "Issue.BoardsUpdated",
                "Issue.DescriptionUpdated",
                "Issue.AssigneeUpdated",
                "Issue.TagsUpdated",
                "Issue.Deleted",
                "Issue.TitleUpdated",
                "Issue.Created",
                "Issue.ChecklistsUpdated",
                "Issue.Moved",
                "Issue.DueDateUpdated",
                "Issue.CustomFieldUpdated",
                "Issue.StatusUpdated"
              ]
            },
            "privateFeed": null,
            "application": {
              "id": "2dd4D44JcWM9"
            },
            "requestedAuthentication": {
              "rights": [
                {
                  "typeCode": "ProjectRightType",
                  "code": "ViewIssues"
                }
              ],
              "rightCodes": [
                "Project.Issues.View"
              ],
              "permissionContext": {
                "className": "ProjectPermissionContext",
                "project": {
                  "id": "2Ektp30zL4Ai"
                }
              },
              "projects": [
                {
                  "id": "2Ektp30zL4Ai"
                }
              ]
            }
          },
          {
            "id": "25nlKl0t76F1",
            "name": "Automation Jobs",
            "enabled": true,
            "subscription": {
              "subjectCode": "AutomationJob",
              "filters": [
                {
                  "className": "AutomationJobSubscriptionFilter",
                  "projects": [
                    {
                      "id": "2Ektp30zL4Ai"
                    }
                  ],
                  "repositoryName": null,
                  "branchSpec": [
                    "*"
                  ],
                  "jobs": null
                }
              ],
              "eventTypeCodes": [
                "Automation.Job.Finished",
                "Automation.Job.Started",
                "Automation.Job.Terminated",
                "Automation.Job.Failed"
              ]
            },
            "privateFeed": null,
            "application": {
              "id": "2dd4D44JcWM9"
            },
            "requestedAuthentication": {
              "rights": [
                {
                  "typeCode": "ProjectRightType",
                  "code": "ViewAutomationExecution"
                }
              ],
              "rightCodes": [
                "Automation.Execution.View"
              ],
              "permissionContext": {
                "className": "ProjectPermissionContext",
                "project": {
                  "id": "2Ektp30zL4Ai"
                }
              },
              "projects": [
                {
                  "id": "2Ektp30zL4Ai"
                }
              ]
            }
          },
          {
            "id": "1AwemD0Ph9BI",
            "name": "Deployment",
            "enabled": true,
            "subscription": {
              "subjectCode": "Deployment",
              "filters": [
                {
                  "className": "DeploymentsSubscriptionFilter",
                  "project": {
                    "id": "2Ektp30zL4Ai"
                  },
                  "repositories": [],
                  "targetIdentifiers": null
                }
              ],
              "eventTypeCodes": [
                "Deployments.Deployment.Failed",
                "Deployments.Deployment.Modified",
                "Deployments.Deployment.Started",
                "Deployments.Deployment.Hanging",
                "Deployments.Deployment.Scheduled",
                "Deployments.Deployment.Completed"
              ]
            },
            "privateFeed": null,
            "application": {
              "id": "2dd4D44JcWM9"
            },
            "requestedAuthentication": {
              "rights": [
                {
                  "typeCode": "ProjectRightType",
                  "code": "ReadDeployments"
                }
              ],
              "rightCodes": [
                "Project.Deployments.View"
              ],
              "permissionContext": {
                "className": "ProjectPermissionContext",
                "project": {
                  "id": "2Ektp30zL4Ai"
                }
              },
              "projects": [
                {
                  "id": "2Ektp30zL4Ai"
                }
              ]
            }
          },
          {
            "id": "3GW7Zs47d2Wl",
            "name": "Git Commit",
            "enabled": true,
            "subscription": {
              "subjectCode": "Repository.Commits",
              "filters": [
                {
                  "className": "RepoCommitsSubscriptionFilter",
                  "project": null,
                  "repository": "",
                  "spec": {
                    "authors": [],
                    "committers": [],
                    "branchSpec": [],
                    "pathSpec": "",
                    "messageRegex": ""
                  }
                }
              ],
              "eventTypeCodes": [
                "Repository.Commits"
              ]
            },
            "privateFeed": null,
            "application": {
              "id": "2dd4D44JcWM9"
            },
            "requestedAuthentication": {
              "rights": [
                {
                  "typeCode": "ProjectRightType",
                  "code": "VcsRead"
                }
              ],
              "rightCodes": [
                "VcsRepository.Read"
              ],
              "permissionContext": {
                "className": "GlobalPermissionContext"
              },
              "projects": []
            }
          },
          {
            "id": "3uv9sy4DbrCg",
            "name": "Code Review",
            "enabled": true,
            "subscription": {
              "subjectCode": "CodeReview",
              "filters": [
                {
                  "className": "CodeReviewSubscriptionFilter",
                  "project": null,
                  "repository": null,
                  "authors": [],
                  "participants": [],
                  "branchSpec": [],
                  "pathSpec": [],
                  "titleRegex": ""
                }
              ],
              "eventTypeCodes": [
                "CodeReview.Created",
                "CodeReview.Closed"
              ]
            },
            "privateFeed": null,
            "application": {
              "id": "2dd4D44JcWM9"
            },
            "requestedAuthentication": {
              "rights": [
                {
                  "typeCode": "ProjectRightType",
                  "code": "VcsRead"
                }
              ],
              "rightCodes": [
                "VcsRepository.Read"
              ],
              "permissionContext": {
                "className": "GlobalPermissionContext"
              },
              "projects": []
            }
          },
          {
            "id": "4ZUTOt4Xo7JP",
            "name": "Documents",
            "enabled": true,
            "subscription": {
              "subjectCode": "Document",
              "filters": [
                {
                  "className": "DocumentCustomSubscriptionFilter",
                  "project": null,
                  "folders": [],
                  "documents": []
                }
              ],
              "eventTypeCodes": [
                "Document.Unarchived",
                "Document.Published",
                "Document.Content.Updated",
                "Document.Created",
                "Document.Archived",
                "Document.Unpublished"
              ]
            },
            "privateFeed": null,
            "application": {
              "id": "2dd4D44JcWM9"
            },
            "requestedAuthentication": {
              "rights": [
                {
                  "typeCode": "DocumentRightType",
                  "code": "ViewDocuments"
                }
              ],
              "rightCodes": [
                "Documents.View"
              ],
              "permissionContext": {
                "className": "GlobalPermissionContext"
              },
              "projects": []
            }
          }
        ],
        "name": "Issues Webhook",
        "description": null,
        "useAppEndpoint": true,
        "endpoint": {
          "url": null,
          "sslVerification": true
        },
        "useAppEndpointAuth": true,
        "endpointAuth": {
          "appLevelAuth": {
            "className": "EndpointAuthRead.PublicKeySignature"
          },
          "sslKeystore": null,
          "verificationToken": false
        },
        "enabled": true,
        "acceptedHttpResponseCodes": [],
        "doRetries": true,
        "payloadFields": "clientId,payload(assignee(new(name),old(name)),checklistDelta(new(name),old(name)),deleted,description,dueDate,issue(projectRef(key(key)),id,number,projectId,title,description,status(name,color),assignee(name(lastName,firstName))),meta(principal(details(user(name),name,app(name))),method,timestamp),sprintDelta(new(name),old(name)),status(new(name,color),old(color,name)),tagDelta(old(name),new(name)),title,topicDelta(new(name),old(name))),webhookId"
      }
    }
  ]
}
@Subtixx Subtixx pinned this issue Apr 27, 2023
@Subtixx Subtixx added the documentation Improvements or additions to documentation label Apr 27, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant