René's URL Explorer Experiment


Title: Create an example job using the Rippling API · Issue #56 · triggerdotdev/api-reference · GitHub

Open Graph Title: Create an example job using the Rippling API · Issue #56 · triggerdotdev/api-reference

X Title: Create an example job using the Rippling API · Issue #56 · triggerdotdev/api-reference

Description: Overview: While we build our official integrations, we want to create examples of how to create jobs which use other APIs with Trigger.dev. This reference will be used in the app on any service we don’t have an integration for yet. Detai...

Open Graph Description: Overview: While we build our official integrations, we want to create examples of how to create jobs which use other APIs with Trigger.dev. This reference will be used in the app on any service we ...

X Description: Overview: While we build our official integrations, we want to create examples of how to create jobs which use other APIs with Trigger.dev. This reference will be used in the app on any service we ...

Opengraph URL: https://github.com/triggerdotdev/api-reference/issues/56

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Create an example job using the Rippling API","articleBody":"## Overview:\r\n\r\nWhile we build our official integrations, we want to create examples of how to create jobs which use other APIs with Trigger.dev. This reference will be used in the app on any service we don’t have an integration for yet.\r\n\r\n## Details:\r\n\r\nIn this example, you will build a simple job which uses the Rippling API. This will replace the GitHub example we currently have in the app:\r\n\r\n![2023-10-26 7](https://github.com/triggerdotdev/api-reference/assets/8297864/35f82b03-0e8d-41ff-b70c-b347b22c4fd1)\r\n\r\n## Requirements:\r\n\r\n- Use the structure of our [GitHub API reference file](https://github.com/triggerdotdev/api-reference/blob/main/src/github.ts).\r\n- The job must connect to the [Rippling API](https://developer.rippling.com/docs/rippling-api/a310f900b0f84-api-reference), using their official SDK, and return an example payload from the API.\r\n\r\n## Guidelines:\r\n\r\n- The job should use an `eventTrigger`.\r\n- The job should use `zod` to define the payloads.\r\n- Use native fetch where no official SDK or incompatible auth\r\n- Only use `io.backgroundFetch()` where absolutely necessary\r\n- Avoid external packages apart from official SDKs\r\n- Prefer REST over GraphQL - avoid raw queries\r\n- Use a minimal `io.runTask()` callback - initialise clients and auth in global scope if possible\r\n- Leave clear comments with links to relevant developer docs, API key pages etc. [The Discord example](https://github.com/triggerdotdev/api-reference/blob/main/src/discord.ts) is the level of commenting we are looking for. \r\n​\r\n## Required Structure:\r\n\r\n1. Follow [this guide](https://github.com/triggerdotdev/api-reference#setup-how-to-use-this-repo) to get the project setup.​\r\n2. Create a new file in the src folder, named to match the API (e.g. GitHub would be called github.ts).​\r\n3. The Trigger.dev client must be defined at the top of the job, with the 'api-reference' id:\r\n\r\n```ts\r\nconst client = new TriggerClient({ id: \"api-reference\" });\r\n```\r\n​\r\n4. You must add the Express specific lines to the bottom of the Job file:\r\n​\r\n```ts\r\n// These lines can be removed if you don't want to use express\r\nimport { createExpressServer } from \"@trigger.dev/express\";\r\ncreateExpressServer(client);\r\n```\r\n​\r\n5. You must add the new script to the package.json file, in this format:\r\n​\r\n```ts\r\n\"scripts\": {\r\n  //..other scripts\r\n  \"\u003capi-name>\": \"nodemon --watch src/\u003capi name>.ts -r tsconfig-paths/register -r dotenv/config src/\u003capi name>.ts\"\r\n}\r\n```\r\n\r\n> [!IMPORTANT]\r\nYou must test this Job works before submitting your PR, including a screenshot of a successful run. This may involve you having to setup accounts with services.\r\n>","author":{"url":"https://github.com/D-K-P","@type":"Person","name":"D-K-P"},"datePublished":"2023-10-26T15:56:37Z","url":"https://github.com/triggerdotdev/api-reference/issues/56"}

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react-reconciler,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@d5750093facf
route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:68820281-87c1-2250-3a39-fe1101e587b7
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idBDFE:250D58:1AC8F6:25A7EF:6AFB6AC5
html-safe-nonce9926f0d82f6954320ebf9a90cecfd970cf6fef8cfd2b824d9e10d4b85c168973
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCREZFOjI1MEQ1ODoxQUM4RjY6MjVBN0VGOjZBRkI2QUM1IiwidmlzaXRvcl9pZCI6IjIwMzU0MTI1MjU1MTk2OTQ1MzMiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmacd5694cf378d82e8dac839810a41b91763a1c6ebfb97b889f12d8a0ae49557473
hovercard-subject-tagissue:1963877180
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/triggerdotdev/api-reference/56/issue_layout
twitter:imagehttps://opengraph.githubassets.com/a78d4ede52fb6389459f64ce008efb0a5345049c7085ef3015297d32cf08e8af/triggerdotdev/api-reference/issues/56
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/a78d4ede52fb6389459f64ce008efb0a5345049c7085ef3015297d32cf08e8af/triggerdotdev/api-reference/issues/56
og:image:altOverview: While we build our official integrations, we want to create examples of how to create jobs which use other APIs with Trigger.dev. This reference will be used in the app on any service we ...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameD-K-P
hostnamegithub.com
expected-hostnamegithub.com
Nonecca289ecd54650fcf3c0b037a58b97186dee2cc4406819d87fab93728fd83700
turbo-cache-controlno-preview
go-importgithub.com/triggerdotdev/api-reference git https://github.com/triggerdotdev/api-reference.git
octolytics-dimension-user_id95297378
octolytics-dimension-user_logintriggerdotdev
octolytics-dimension-repository_id706112555
octolytics-dimension-repository_nwotriggerdotdev/api-reference
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id706112555
octolytics-dimension-repository_network_root_nwotriggerdotdev/api-reference
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release88808b1fae5ab8a526a73e7ce5542a10eb9d6971
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/triggerdotdev/api-reference/issues/56#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Ftriggerdotdev%2Fapi-reference%2Fissues%2F56
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Ftriggerdotdev%2Fapi-reference%2Fissues%2F56
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=triggerdotdev%2Fapi-reference
Reloadhttps://github.com/triggerdotdev/api-reference/issues/56
Reloadhttps://github.com/triggerdotdev/api-reference/issues/56
Reloadhttps://github.com/triggerdotdev/api-reference/issues/56
triggerdotdevhttps://github.com/triggerdotdev
api-referencehttps://github.com/triggerdotdev/api-reference
Codehttps://github.com/triggerdotdev/api-reference
Issueshttps://github.com/triggerdotdev/api-reference/issues
Pull requests1 (1)https://github.com/triggerdotdev/api-reference/pulls
Actionshttps://github.com/triggerdotdev/api-reference/actions
Projectshttps://github.com/triggerdotdev/api-reference/projects
Security and qualityhttps://github.com/triggerdotdev/api-reference/security
Insightshttps://github.com/triggerdotdev/api-reference/pulse
https://github.com/triggerdotdev/api-reference
New issuehttps://github.com/login?return_to=https://github.com/triggerdotdev/api-reference/issues/56
New issuehttps://github.com/login?return_to=https://github.com/triggerdotdev/api-reference/issues/56
#142https://github.com/triggerdotdev/api-reference/pull/142
Create an example job using the Rippling APIhttps://github.com/triggerdotdev/api-reference/issues/56#top
#142https://github.com/triggerdotdev/api-reference/pull/142
https://github.com/D-K-P
D-K-Phttps://github.com/D-K-P
on Oct 26, 2023https://github.com/triggerdotdev/api-reference/issues/56#issue-1963877180
https://private-user-images.githubusercontent.com/8297864/278393981-35f82b03-0e8d-41ff-b70c-b347b22c4fd1.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3OTQ4NjIwNjYsIm5iZiI6MTc5NDg2MTc2NiwicGF0aCI6Ii84Mjk3ODY0LzI3ODM5Mzk4MS0zNWY4MmIwMy0wZThkLTQxZmYtYjcwYy1iMzQ3YjIyYzRmZDEucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI2MTExNiUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNjExMTZUMjA0MjQ2WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9Y2M0NDQ1ZTg3OGZjODU4NmExMDJhNTI2M2QwZGIwNWViM2IzZTdkMmQzZGFhZDFiMzc3ZjQ4ZjBlYTcwMGJiZCZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmcmVzcG9uc2UtY29udGVudC10eXBlPWltYWdlJTJGcG5nIn0.JkcSWn-VEdtAJpyVW35d-te0pmxoL-kPqXFqE71023s
GitHub API reference filehttps://github.com/triggerdotdev/api-reference/blob/main/src/github.ts
Rippling APIhttps://developer.rippling.com/docs/rippling-api/a310f900b0f84-api-reference
The Discord examplehttps://github.com/triggerdotdev/api-reference/blob/main/src/discord.ts
this guidehttps://github.com/triggerdotdev/api-reference#setup-how-to-use-this-repo
D-K-Phttps://github.com/D-K-P
🎃hacktoberfesthttps://github.com/triggerdotdev/api-reference/issues?q=state%3Aopen%20label%3A%22%F0%9F%8E%83hacktoberfest%22
💎💎 250 pointshttps://github.com/triggerdotdev/api-reference/issues?q=state%3Aopen%20label%3A%22%F0%9F%92%8E%F0%9F%92%8E%20250%20points%22
🎃hacktoberfesthttps://github.com/triggerdotdev/api-reference/issues?q=state%3Aopen%20label%3A%22%F0%9F%8E%83hacktoberfest%22
💎💎 250 pointshttps://github.com/triggerdotdev/api-reference/issues?q=state%3Aopen%20label%3A%22%F0%9F%92%8E%F0%9F%92%8E%20250%20points%22
on Oct 26, 2023https://github.com/triggerdotdev/api-reference/issues/56#event-10781893138
D-K-Phttps://github.com/D-K-P
completedhttps://github.com/triggerdotdev/api-reference/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
#142https://github.com/triggerdotdev/api-reference/pull/142
on Feb 15, 2024https://github.com/triggerdotdev/api-reference/issues/56#event-11817331645
Sign up for freehttps://github.com/signup?return_to=https://github.com/triggerdotdev/api-reference/issues/56
Sign in to commenthttps://github.com/login?return_to=https://github.com/triggerdotdev/api-reference/issues/56
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.