Webhooks

Query

Open full page ↗Raw SDL

Retrieve WebhookItems related to current Account.

Returns

WebhookItems

Arguments

limit:Int = 25Optional: How many WebhookItems to show per query. Min: 1, Max: 100.
page:Int = 1Optional: Current page number.

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

query Webhooks {
  webhooks(
    
    
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "webhooks": {
      "__typename": "WebhookItems"
    }
  }
}

Mutation

configureProjectWebhook

Open full page ↗Raw SDL

configureProjectWebhook mutation field

Returns

ConfigureProjectWebhook

Arguments

input:ConfigureProjectWebhookInput!Required: configureProjectWebhook input argument.; RequiredprojectId: ID!, notificationUrl: String!, name: String!, version: Int!; OptionalsubscribeTo: [AssetWebhookEvent!]

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation ConfigureProjectWebhook {
  configureProjectWebhook(
    input: {
      projectId: 
      notificationUrl: 
      name: 
      version: 
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "configureProjectWebhook": {
      "__typename": "ConfigureProjectWebhook"
    }
  }
}

Mutation

installProjectWebhook

Open full page ↗Raw SDL

Install Webhook. Requires basic:write and webhook:write scopes to be accessible and Project permission level EDIT.

Returns

InstallProjectWebhook

Arguments

input:InstallProjectWebhookInput!Required: InstallProjectWebhook input argument.; RequiredprojectId: ID!, notificationUrl: Url!, name: String!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation InstallProjectWebhook {
  installProjectWebhook(
    input: {
      projectId: 
      notificationUrl: 
      name: 
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "installProjectWebhook": {
      "__typename": "InstallProjectWebhook"
    }
  }
}

Mutation

uninstallWebhook

Open full page ↗Raw SDL

Uninstall Webhook. Requires basic:write and webhook:write scopes to be accessible and Project permission level EDIT.

Returns

UninstallWebhook

Arguments

input:UninstallWebhookInput!Required: UninstallWebhook input argument.; Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

idID!

Example

mutation UninstallWebhook {
  uninstallWebhook(
    input: {
      id: 
    }
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "uninstallWebhook": {
      "__typename": "UninstallWebhook",
      "id": "eyJXXXXXXXX…"
    }
  }
}