Files
Eric Allam c0dfa8048a feat: BYO Auth (#491)
* feat: BYO Auth

Define client-side auth resolvers to be able to supply custom authentication credentials for integrations before a run is performed

- Added new defineAuthResolver
- Update all integrations to support the new auth resolvers
- Strip internal symbols from .d.ts in integrations and trigger-sdk
- Added BYO Auth docs
- Update Dynamic Schedule to support associated account IDs
- Create external accounts just-in-time
- Added Account ID field to test job when there are external auth integrations
- Show Account ID on run dashboard
- Added new Run error state called “Unresolved auth”

* Added changeset

* Remove @internal from TriggerIntegration public methods

* Add void to the result union

* DynamicTriggers now work with the new BYO auth system, and added a bunch of docs and docs changes

* Add additional key material for registering dynamic trigger task

* Add new define* instance methods to the overview
2023-09-22 08:54:31 -07:00

30 lines
634 B
Plaintext

---
title: "defineDynamicSchedule()"
description: "Define a Dynamic Schedule"
---
## Parameters
<ResponseField name="options" type="DynamicScheduleOptions" required>
The options for the dynamic schedule.
<Expandable title="options" defaultOpen>
<ResponseField name="id" type="string" required>
Used to uniquely identify a DynamicSchedule
</ResponseField>
</Expandable>
</ResponseField>
## Returns
<ResponseField name="DynamicSchedule instance" type="DynamicSchedule" />
<RequestExample>
```ts example
const dynamicSchedule = client.defineDynamicSchedule({
id: "dynamicinterval",
});
```
</RequestExample>