Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yrka.io/llms.txt

Use this file to discover all available pages before exploring further.

Integrations is where you manage the connections between Yrka and external services: payroll providers, calendar systems, notification channels, file sources, and extended app catalog providers. Before connecting anything, check the provider’s readiness label — not every provider in the catalog is live and available for automated sync. Readiness labels tell you whether a provider path is fully available, setup-required, a reviewed handoff, or a roadmap target.
Seeing a provider in the catalog does not mean it is ready for live automation. Always check the readiness badge and setup requirements on the provider detail sheet before promising a live integration to your team.

​
Provider catalog

Open Admin Tools > Integrations to browse the provider marketplace. Use the view switcher to toggle between Marketplace (for discovery) and Connections (for your organization’s current provider records).

​
Provider readiness labels

LabelWhat it means
ReadyThe provider path has the required setup for the supported action
Live connectionA supported connection or delivery pipe path is available; setup and authorization requirements still apply
Reviewed handoffYrka stages or exports data for human review instead of calling a live provider API
Provider-gatedLive behavior depends on provider approval, credentials, scopes, or operator setup
Flagship targetYrka owns the setup, routing, review, recovery, docs, and support boundary for this provider
Extended catalogThe provider can use the governed runtime and shared policy/audit model, but with a lower product-support promise than flagship
Manual exportYrka prepares a reviewed handoff file — not a live provider submission
Planned targetVisible for roadmap review only; not available for setup or live sync
Disconnected / RevokedMust be reconnected before future sync or delivery
FailedReview the safe error summary before retrying
Needs attentionA remediation hint is available; use the owning workflow before retrying

​
Flagship providers

Yrka owns the full setup, routing, review, recovery, and support boundary for flagship providers. The flagship set includes:
Google Workspace (Gmail, Google Calendar, Google Drive, Google Docs/Sheets) and Microsoft 365 (Outlook Mail, Outlook Calendar, SharePoint/OneDrive, Teams Graph) are grouped flagship providers — one auth posture covers the full suite for each.

​
Connecting OAuth providers

1

Open the provider detail sheet

Find the provider in the marketplace and open its detail sheet. Review setup options, required scopes, readiness checks, the connection owner scope (user-owned or organization-owned), and the provider path.
2

Confirm prerequisites

Before starting OAuth, confirm that the provider app is configured with the required scopes and your organization has authorized the connection. Your Yrka account owner or support contact can confirm whether server-side setup is complete for your specific provider.
3

Start OAuth

Select Connect from the provider detail sheet. After the OAuth callback completes, refresh the provider status in Integrations to confirm the connection is active.
4

Confirm the connection status

Return to the provider detail sheet after the OAuth callback. Confirm the connection shows as active or connected. If the status shows setup-required or inactive after a successful callback, refresh provider status to normalize the account record.
Start OAuth only for providers with configured apps, redirect allowlists, scopes, and customer authorization. Do not attempt to connect a provider that shows as provider-gated or planned target — live automation is not available for those paths.

​
Reconnecting a revoked provider

If a provider connection has been revoked or expired, disconnect it through the supported control on the provider detail sheet, then start a fresh provider setup. Do not retry a failed connection directly — clear the broken state first.

​
Manual export providers

When live API activation is not ready for a provider, use the manual export or reviewed handoff path. Yrka prepares a reviewed file (CSV, TSV, or provider-shaped export) that you download and upload to the provider yourself. Manual export profiles let you save the selected export pack and field mappings so you can reuse the same reviewed handoff without reconfiguring each time. Configure profiles in Admin > Payroll or through the export settings in Integrations.

​
Payroll bridge providers

Payroll bridge providers — including ADP Workforce Now, Paychex Flex, Paylocity, QuickBooks Online, Gusto, and others — support reviewed time-draft payloads, roster reads, and explicit handoff points. These are not live payroll submission paths: all payroll-provider handoffs are customer-reviewed exports.
Yrka does not process payroll, file taxes, or submit payroll directly to any provider. Payroll handoffs are customer-reviewed export files. The admin remains responsible for reviewing the export before sending it to a payroll provider.

​
Calendar sync

Yrka supports reviewed calendar sync through Google Calendar, Microsoft 365 Calendar, and Apple Calendar ICS profiles. These paths stage calendar events into Schedule import review — they do not publish events directly to your schedule.
1

Configure the calendar provider

In Integrations, open the calendar provider detail sheet and confirm provider credentials and authorization are ready. For ICS profiles, upload the ICS file directly.
2

Review staged events

Calendar sync stages events into Schedule import review. Open Imports > Schedule to review staged rows.
3

Select the target calendar

Before committing, confirm the target Schedule calendar shown on the staged batch. Provider calendar names and Yrka schedule calendars are separate — confirm the right internal calendar before committing rows.
4

Commit

Commit reviewed, ready rows. They land in the selected Schedule calendar.

​
Notification pipes

Configure external notification delivery through Settings > Communications and Notifications and through the provider cards in Integrations.
Email delivery requires Resend setup with verified domain/DNS. Until domain verification is complete, use the manual invite link fallback in Personnel for employee invitations. In-app notifications remain the durable source of truth — email is a delivery pipe, not the canonical record.
Slack webhook delivery is available for outbound notifications once the webhook URL is configured on the server side. Configure the webhook in Integrations and send a test from the Slack provider card to confirm delivery is working.
Slack app OAuth requires a connected Slack account and a Slack channel ID configured on the connection before diagnostic delivery is available. Slack interactive approvals, slash commands, two-way workflows, and broad bot behaviors are outside current supported features.
SMS delivery requires server-side Twilio configuration and an auditable connection record. Configure the Twilio provider in Integrations and test from the provider card before expecting SMS delivery in production.
For notification provider diagnostics, always send the test from the specific provider card in Integrations — not from a general test action. This ensures the delivery ledger records the selected pipe’s result rather than a different default channel.

​
Sync jobs and provider status

1

Open the sync history

Go to Admin Tools > Integrations and use Overview for a current health summary or Sync History for the activity table.
2

Review provider health

Check last activity, health status, safe error messages, sync attempt counts, and exhausted retry states for each provider.
3

Identify the next action

The provider status should point to whether the next step belongs in Integrations, the owning workflow (Schedule, Resources, Payroll, Messages, Imports), or support. Follow the remediation hint before retrying blindly.
4

Retry when appropriate

Retry a sync job only when the issue is transient and the source record still needs the same work. Pause or reconnect when provider credentials, authorization, or mapping need review first.

​
Sync job status meanings

StatusWhat it means
Healthy / ReadyThe supported path is available
DegradedThe provider path needs review; the owning workflow may still be available manually
RetryingAnother attempt is queued or allowed
ExhaustedRetries have stopped; support or operator review is needed
PausedSync or delivery will not run until an admin re-enables it
RequestedAn admin asked Yrka to run a remediation — wait for the follow-up event before treating the issue as fixed

​
External action settings and safety controls

You can tune external action controls in Settings > Imports and Integrations. These settings govern how external writes, trigger deliveries, and Zavi external actions behave across the organization:
  • Provider lane and action class controls — restrict or allow action classes by provider lane
  • Daily caps — limit how many external actions can execute per day
  • Retention and redaction — configure how long external action evidence is retained and what fields are redacted
  • External write and trigger pauses — pause all external writes or trigger deliveries organization-wide
  • Emergency pause — halt all governed external actions immediately
  • Provider-specific overrides — explicitly enable or disable a provider while global controls remain authoritative for pauses, sensitive-data refusals, and cap boundaries
A provider override set to “inherit” means the global setting is still authoritative. An explicit provider enablement does not bypass emergency pauses, class/data/owner restrictions, permission checks, or sensitive-data refusal rules.

​
Troubleshooting

Check provider configuration, allowed redirect URIs, required scopes, and organization authorization. If setup is blocked, contact your Yrka account owner or support — extended catalog providers may require additional server-side configuration before the Connect button is available.
Refresh the provider status from the provider detail sheet so Yrka can normalize the local connected-account bridge. After the status updates, retry the action.
Confirm your Slack connection is active and a Slack channel ID is configured on the connection record. A skipped delivery is not the same as a provider outage — confirm setup is complete before escalating.
Check whether the events staged into Schedule import review rather than directly publishing. Open Imports > Schedule and confirm the target calendar shown on the staged batch before committing.
Use the provider’s next recovery action and the owning source page — do not replay blindly. Collect the provider name, connection status, time, and owning workflow information if you need to escalate to support.
Check the emergency pause state, Zavi external-action pause, external write pause, trigger pause, provider-lane pause, provider override, action class, data class, owner scope, role key, daily cap, retention class, and external write toggles in Settings > Imports and Integrations before retrying.