Check and sync an integration

POST

/api/v1/integrations/{id}/sync

const url = 'https://digize.com/api/v1/integrations/stripe/sync';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69',
    'x-api-key': '<x-api-key>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://digize.com/api/v1/integrations/stripe/sync \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>'

Checks a connected service still answers, and brings in what’s new from it.

Needs the settings:write permission.

Authorizations

apiKey
bearer

Parameters

Path Parameters

required

string

Allowed values: stripe twilio google_calendar google_business google_search_console google_sheets meta google_ads tiktok_ads linkedin_ads microsoft_ads pinterest_ads slack quickbooks xero zapier leadsplease click2mail

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Responses

200

Done

application/json

object

required

string

status

required

string

Allowed values: connected error not_connected

account

required

What it’s connected as: an account, a number, an email.

string | null

details

required

Array<string>

scopes

required

What the workspace allowed it to do when it connected.

Array<string>

connectedBy

required

string | null

connectedAt

required

Any of:

string
null

string format: date-time

lastSyncAt

required

Any of:

string
null

string format: date-time

webhook

required

Any of:

object
null

object

url

required

string

status

required

string

Allowed values: healthy failing

lastDeliveryAt

required

string format: date-time

failures

required

integer

<= 9007199254740991

error

required

Why it needs attention.

string | null

connectWith

required

Any of:

string
null

string

Allowed values: oauth credentials onboarding

ready

required

Whether this server has the service’s app credentials, so Connect can work.

boolean

Example

{
  "id": "stripe",
  "status": "connected",
  "webhook": {
    "status": "healthy"
  },
  "connectWith": "oauth"
}

400

What was sent isn’t valid (invalid).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}