{"id":21406675,"url":"https://github.com/ringcentral/engage-digital-api-docs","last_synced_at":"2026-01-03T14:10:00.574Z","repository":{"id":246498989,"uuid":"196323870","full_name":"ringcentral/engage-digital-api-docs","owner":"ringcentral","description":"API Documentation for RingCX","archived":false,"fork":false,"pushed_at":"2025-03-06T14:40:52.000Z","size":19172,"stargazers_count":5,"open_issues_count":5,"forks_count":30,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-03-06T15:35:11.333Z","etag":null,"topics":["documentation","ringcx"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ringcentral.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-11T05:12:11.000Z","updated_at":"2025-03-06T14:40:56.000Z","dependencies_parsed_at":"2024-06-28T10:28:11.658Z","dependency_job_id":"93bd4371-652c-4a04-8dbe-498ef1c04f1d","html_url":"https://github.com/ringcentral/engage-digital-api-docs","commit_stats":null,"previous_names":["ringcentral/engage-digital-api-docs"],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-digital-api-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-digital-api-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-digital-api-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fengage-digital-api-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ringcentral","download_url":"https://codeload.github.com/ringcentral/engage-digital-api-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243902321,"owners_count":20366262,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","ringcx"],"created_at":"2024-11-22T16:41:35.784Z","updated_at":"2026-01-03T14:10:00.534Z","avatar_url":"https://github.com/ringcentral.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RingCentral Engage API Docs\n\n[![Build Status][specs-status-svg]][specs-status-url]\n[![Docs Status][docs-status-svg]][docs-status-url]\n[![Docs][docs-svg]][docs-url]\n\nThis repository is the home of the RingCentral Engage Developer Guide: a collection of materials, and documentation to help educate developers on how to build on top of the RingCentral Engage platform.\n\nVisit a [live preview][docs-url] of https://developers.ringcentral.com/engage/digital/guide\n\n## Contributing\n\nIf you would like to contribute to the RingCentral documentation effort, fork this repository, make your desired edits and contributions, and issue a pull request accordingly.\n\n### Running ReadTheDocs Locally\n\n```\n% git clone https://github.com/ringcentral/engage-digital-api-docs.git\n% cd engage-digital-api-docs\n% pip install mkdocs mkdocs-ringcentral mdx_include\n% python3 -m mkdocs serve -a localhost:8000\n```\n\nOr with docker:\n\n```\n./preview.sh\n```\n\nThen you should be able to load http://localhost:8000 to view the documentation.\n\n### Generating OpenAPI doc\n\nGo check [specs/README.md](specs/README.md)\n\n### Testing OpenAPI Specs\n\nThis repo holds OpenAPI specs for Engage Digital.\n\nYou can preview the latest version of the swagger spec on the [swagger preview][swagger-preview]\n\nFor each commit, tests are run on Travis CI to verify that the OpenAPI 3.0 specs validate.\n\n* Engage Digital Spec: [specs/digital/engage-digital_openapi3.yaml](specs/engage-digital_openapi3.yaml)\n* Tests: [specs_test.go](specs_test.go)\n\nYou can verify the specs localy with the following if you have [Go installed](https://golang.org/).\n\n```\n% git clone https://github.com/ringcentral/ringcentral-api-docs.git\n% cd ringcentral-api-docs\n% go test -v ./...\n```\n\nIf you wish to change the specs being tested edit the [specs_test.go](specs_test.go) file.\n\n [specs-status-svg]: https://github.com/ringcentral/engage-digital-api-docs/workflows/spec%20build/badge.svg?branch=master\n [specs-status-url]: https://github.com/ringcentral/engage-digital-api-docs/actions\n [docs-status-svg]: https://readthedocs.org/projects/engage-digital-api-docs/badge/?version=latest\n [docs-status-url]: https://readthedocs.org/projects/engage-digital-api-docs/builds/\n [docs-svg]: https://img.shields.io/badge/docs-readthedocs-blue.svg\n [docs-url]: https://engage-digital-api-docs.readthedocs.io/en/latest/\n [swagger-preview]: https://ringcentral.github.io/engage-digital-api-docs/digital/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fengage-digital-api-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fringcentral%2Fengage-digital-api-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fengage-digital-api-docs/lists"}