@@ -173,14 +173,6 @@ await nango.getIntegration(<INTEGRATION-ID>);
173
173
<ResponseField name = " include" type = " array" >
174
174
Include sensitive data. Allowed values: ` webhook `
175
175
</ResponseField >
176
-
177
- <ResponseField name = " providerConfigKey" type = " string" required deprecated >
178
- The integration ID.
179
- </ResponseField >
180
-
181
- <ResponseField name = " includeIntegrationCredentials" type = " boolean" deprecated >
182
- Defaults to ` false ` .
183
- </ResponseField >
184
176
</Expandable >
185
177
186
178
** Example Response**
@@ -204,6 +196,9 @@ await nango.getIntegration(<INTEGRATION-ID>);
204
196
Create a new integration.
205
197
206
198
``` js
199
+ await nango .createIntegration ({ provider: < PROVIDER - ID > , unique_key: < UNIQUE_KEY > , [... ] });
200
+
201
+ // Deprecated
207
202
await nango .createIntegration (< PROVIDER - ID > , < INTEGRATION - ID > );
208
203
```
209
204
@@ -214,92 +209,73 @@ await nango.createIntegration(<PROVIDER-ID>, <INTEGRATION-ID>);
214
209
The ID of the API provider in Nango (cf. [ providers.yaml] ( https://nango.dev/providers.yaml ) for a list of API provider IDs.)
215
210
</ResponseField >
216
211
217
- <ResponseField name = " providerConfigKey " type = " string" required >
212
+ <ResponseField name = " unique_key " type = " string" required >
218
213
The integration ID.
219
214
</ResponseField >
220
215
221
- <ResponseField name = " credentials " type = " Record< string, string> " >
222
- The credentials to include depend on the specific integration that you want to create.
216
+ <ResponseField name = " display_name " type = " string" >
217
+ The display name of this integration
223
218
</ResponseField >
224
219
225
220
<ResponseField name = " credentials" type = " Record<string, string>" >
226
- <Expandable title = " credentials" defaultOpen >
227
- <ResponseField name = " oauth_client_id" type = " string" >
228
- The OAuth client ID.
229
- </ResponseField >
230
-
231
- <ResponseField name = " oauth_client_secret" type = " string" >
232
- The OAuth client secret.
233
- </ResponseField >
234
-
235
- <ResponseField name = " oauth_scopes" type = " string" >
236
- The list of OAuth scopes
237
- </ResponseField >
238
- </Expandable >
239
- </ResponseField >
221
+ The credentials to include depend on the specific integration that you want to create.
222
+ </ResponseField >
240
223
</Expandable >
241
224
242
225
** Example Response**
243
226
244
227
<Expandable >
245
228
``` json
246
229
{
247
- "config " : {
230
+ "data " : {
248
231
"unique_key" : " slack-nango-community" ,
249
- "provider" : " slack"
232
+ "provider" : " slack" ,
233
+ "logo" : " http://localhost:3003/images/template-logos/slack.svg" ,
234
+ "created_at" : " 2023-10-16T08:45:26.241Z" ,
235
+ "updated_at" : " 2023-10-16T08:45:26.241Z" ,
250
236
}
251
237
}
252
238
```
253
239
</Expandable >
254
240
255
241
### Update an integration
256
242
257
- Edits an integration (only for OAuth APIs) .
243
+ Patch an integration, all fields are optional .
258
244
259
245
``` js
246
+ await nango .updateIntegration ({ uniqueKey: < UNIQUE_KEY > }, { [... body] });
247
+
248
+ // Deprecated
260
249
await nango .updateIntegration (< PROVIDER - ID > , < INTEGRATION - ID > );
261
250
```
262
251
263
252
** Parameters**
264
253
265
254
<Expandable >
266
- <ResponseField name = " provider " type = " string" required >
267
- The ID of the API provider in Nango (cf. [ providers.yaml ] ( https://nango.dev/providers.yaml ) for a list of API provider IDs.)
255
+ <ResponseField name = " unique_key " type = " string" >
256
+ The integration ID.
268
257
</ResponseField >
269
258
270
- <ResponseField name = " providerConfigKey " type = " string" required >
271
- The integration ID.
259
+ <ResponseField name = " display_name " type = " string" >
260
+ The display name of this integration
272
261
</ResponseField >
273
262
274
263
<ResponseField name = " credentials" type = " Record<string, string>" >
275
264
The credentials to include depend on the specific integration that you want to create.
276
265
</ResponseField >
277
-
278
- <ResponseField name = " credentials" type = " Record<string, string>" >
279
- <Expandable title = " credentials" defaultOpen >
280
- <ResponseField name = " oauth_client_id" type = " string" >
281
- The OAuth client ID.
282
- </ResponseField >
283
-
284
- <ResponseField name = " oauth_client_secret" type = " string" >
285
- The OAuth client secret.
286
- </ResponseField >
287
-
288
- <ResponseField name = " oauth_scopes" type = " string" >
289
- The list of OAuth scopes
290
- </ResponseField >
291
- </Expandable >
292
- </ResponseField >
293
266
</Expandable >
294
267
295
268
** Example Response**
296
269
297
270
<Expandable >
298
271
``` json
299
272
{
300
- "config " : {
273
+ "data " : {
301
274
"unique_key" : " slack-nango-community" ,
302
- "provider" : " slack"
275
+ "provider" : " slack" ,
276
+ "logo" : " http://localhost:3003/images/template-logos/slack.svg" ,
277
+ "created_at" : " 2023-10-16T08:45:26.241Z" ,
278
+ "updated_at" : " 2023-10-16T08:45:26.241Z" ,
303
279
}
304
280
}
305
281
```
@@ -310,13 +286,13 @@ await nango.updateIntegration(<PROVIDER-ID>, <INTEGRATION-ID>);
310
286
Deletes a specific integration.
311
287
312
288
``` js
313
- await nango .deleteIntegration (< INTEGRATION - ID > );
289
+ await nango .deleteIntegration (< UNIQUE_KEY > );
314
290
```
315
291
316
292
** Parameters**
317
293
318
294
<Expandable >
319
- <ResponseField name = " providerConfigKey " type = " string" required >
295
+ <ResponseField name = " uniqueKey " type = " string" required >
320
296
The integration ID.
321
297
</ResponseField >
322
298
</Expandable >
@@ -326,10 +302,7 @@ await nango.deleteIntegration(<INTEGRATION-ID>);
326
302
<Expandable >
327
303
``` json
328
304
{
329
- "config" : {
330
- "unique_key" : " slack-nango-community" ,
331
- "provider" : " slack"
332
- }
305
+ "success" : true
333
306
}
334
307
```
335
308
</Expandable >
0 commit comments