App
App metadata
Usage profiles
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
id | string | Optional | Identifier of the app record. |
nameSlug | string | Optional | Unique slug identifier (e.g., "slack", "github"). |
name | string | Optional | Display name of the integration app in the Pipedream catalog. |
authType | string (AUTH_TYPE_KEYS, AUTH_TYPE_OAUTH, AUTH_TYPE_NONE) or integer (int32) | Optional | Authentication mechanism reported for the connected account or app. |
description | string | Optional | Human-readable description of the resource. |
imgSrc | string | Optional | Image URL supplied for the integration app. |
customFieldsJson | string | Optional | JSON string for custom fields. |
categories | Array of string | Optional | Categories assigned to the integration app. |
featuredWeight | integer (int32) | Optional | Provider weight used to order featured apps. Minimum: -2147483648. Maximum: 2147483647. |
Values of authType
Credential mechanism an integration app uses when connecting an account.
| Value | No. | Form | Meaning |
|---|---|---|---|
AUTH_TYPE_KEYS | 1 | Canonical | The app uses API-key credentials. |
AUTH_TYPE_OAUTH | 2 | Canonical | The app uses an OAuth authorization flow. |
AUTH_TYPE_NONE | 3 | Canonical | The app does not require authentication credentials. |
Where used
| Reference | Relationship |
|---|---|
| List connectable apps | POST /api/v1/integrations/pipedream/list-apps |
| Retrieve one app by slug | POST /api/v1/integrations/pipedream/retrieve-app |
Download the public reference contract.
Document: DOC-API-MODEL-app.