Menu

Sync

3 endpoints in the Mattering Calendar API. Service tier only.

POST sync/booking/{public_id}/ Service tier

Cloud Tasks target: mirror one booking to the host's calendar.

Some branches answer 403 internal_only on the user tier.

URL

  • Service tierhttps://calendar.mattering.io/api/internal/v1/sync/booking/{public_id}/

Path parameters

NameType
public_idslug

Responses

200 bare JSON object (no envelope)

{
  "skipped": "unknown_booking"
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
403forbidden

Example

curl -X POST "https://calendar.mattering.io/api/internal/v1/sync/booking/PUBLIC_ID/" \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com"

Source: CalendarCore/sync_tasks.py (sync_tasks.booking_push_task)

POST sync/connection/{connection_id}/ Service tier

Cloud Tasks target: one sync slice, then re-enqueue while the full sync is unfinished. Always 200 once authorized: Cloud Tasks retries non-2xx, and failures are already recorded on the connection.

Some branches answer 403 internal_only on the user tier.

URL

  • Service tierhttps://calendar.mattering.io/api/internal/v1/sync/connection/{connection_id}/

Path parameters

NameType
connection_iduuid

Responses

200 bare JSON object (no envelope)

{
  "processed": "...",
  "full_sync": "...",
  "chained": "..."
}

200 bare JSON object (no envelope)

{
  "skipped": "not_active"
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
403forbidden

Example

curl -X POST "https://calendar.mattering.io/api/internal/v1/sync/connection/CONNECTION_ID/" \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com"

Source: CalendarCore/sync_tasks.py (sync_tasks.connection_sync_task)

POST sync/notify/ Service tier

Provider push, relayed by Automations: ``{provider, connector_instance_id}``. The push carries no event data; it is a nudge to run an incremental sync for that connection now rather than at the next tick.

Some branches answer 403 internal_only on the user tier.

URL

  • Service tierhttps://calendar.mattering.io/api/internal/v1/sync/notify/

Body keys (JSON)

KeyRequiredDefault
connector_instance_idoptional or conditionalnone
provideroptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Responses

200 bare JSON object (no envelope)

{
  "connection": "...",
  "sync": "..."
}

200 bare JSON object (no envelope)

{
  "skipped": "unknown_connection"
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
403forbidden

Example

curl -X POST "https://calendar.mattering.io/api/internal/v1/sync/notify/" \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com" \
  -H "Content-Type: application/json" \
  -d '{
  "connector_instance_id": "...",
  "provider": "..."
}'

Source: CalendarCore/sync_tasks.py (sync_tasks.sync_notify)

All Calendar resources
Start Free Explore our Products