syncIntegration

Force an integration-wide sync (all imported assets) via a single env-wide message

syncIntegration(
  input: SyncIntegrationInput!
): SyncIntegrationPayload

Arguments

syncIntegration.input ● SyncIntegrationInput! non-null input

Parameters for SyncIntegration

Type

SyncIntegrationPayload object

Autogenerated return type of SyncIntegration.

Example request

This generated mutation uses placeholders for required values. Replace them with values available to your API key before running it.

Before you run it

Run the integrations query first and use data.integrations.collection[].id as integrationId.

cURL

curl --request POST https://api.convisoappsec.com/graphql \
  --header "x-api-key: $CONVISO_API_KEY" \
  --header "content-type: application/json" \
  --data '{"query":"mutation MutateSyncIntegration($input: SyncIntegrationInput!) {\n  syncIntegration(input: $input) { clientMutationId enqueued failureReason }\n}","variables":{"input":{"integrationId":"<integration_id>"}}}'

JavaScript

const response = await fetch('https://api.convisoappsec.com/graphql', {
  method: 'POST',
  headers: {
    'content-type': 'application/json',
    'x-api-key': process.env.CONVISO_API_KEY,
  },
  body: JSON.stringify({
    query: "mutation MutateSyncIntegration($input: SyncIntegrationInput!) {\n  syncIntegration(input: $input) { clientMutationId enqueued failureReason }\n}",
    variables: {
    "input": {
        "integrationId": "<integration_id>"
    }
},
  }),
});

const { data, errors } = await response.json();

if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);

Python

import json
import os
import requests

response = requests.post(
    'https://api.convisoappsec.com/graphql',
    headers={
        'content-type': 'application/json',
        'x-api-key': os.environ['CONVISO_API_KEY'],
    },
    json={
        'query': "mutation MutateSyncIntegration($input: SyncIntegrationInput!) {\n  syncIntegration(input: $input) { clientMutationId enqueued failureReason }\n}",
        'variables': json.loads("{\"input\":{\"integrationId\":\"<integration_id>\"}}"),
    },
    timeout=30,
)
response.raise_for_status()

payload = response.json()
if payload.get('errors'):
    raise RuntimeError(payload['errors'])

print(payload['data'])