Section ID:
Values of
DOC-API-MODEL-schema-oti80oaqc4#overview
App
App metadata
Meaning and usage
Section ID: DOC-API-MODEL-schema-oti80oaqc4#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-oti80oaqc4#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-oti80oaqc4#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-oti80oaqc4#field-idSection ID: DOC-API-MODEL-schema-oti80oaqc4#response-field-idid | string | Optional | Identifier of the app record. |
Section ID: DOC-API-MODEL-schema-oti80oaqc4#field-nameslugSection ID: DOC-API-MODEL-schema-oti80oaqc4#response-field-nameslugnameSlug | string | Optional | Unique slug identifier (e.g., "slack", "github"). |
Section ID: DOC-API-MODEL-schema-oti80oaqc4#field-nameSection ID: DOC-API-MODEL-schema-oti80oaqc4#response-field-namename | string | Optional | Display name of the integration app in the Pipedream catalog. |
Section ID: DOC-API-MODEL-schema-oti80oaqc4#field-authtypeSection ID: DOC-API-MODEL-schema-oti80oaqc4#response-field-authtypeauthType | string (AUTH_TYPE_KEYS, AUTH_TYPE_OAUTH, AUTH_TYPE_NONE) or integer (int32) | Optional; explicit presence | Authentication mechanism reported for the integration app. |
Section ID: DOC-API-MODEL-schema-oti80oaqc4#field-descriptionSection ID: DOC-API-MODEL-schema-oti80oaqc4#response-field-descriptiondescription | string | Optional | Human-readable description of the resource. |
Section ID: DOC-API-MODEL-schema-oti80oaqc4#field-imgsrcSection ID: DOC-API-MODEL-schema-oti80oaqc4#response-field-imgsrcimgSrc | string | Optional | Logo image URL supplied for the integration app. |
Section ID: DOC-API-MODEL-schema-oti80oaqc4#field-customfieldsjsonSection ID: DOC-API-MODEL-schema-oti80oaqc4#response-field-customfieldsjsoncustomFieldsJson | string | Optional | JSON string for custom fields. |
Section ID: DOC-API-MODEL-schema-oti80oaqc4#field-categoriesSection ID: DOC-API-MODEL-schema-oti80oaqc4#response-field-categoriescategories | Array of string | Optional | Categories assigned to the integration app. |
Section ID: DOC-API-MODEL-schema-oti80oaqc4#field-featuredweightSection ID: DOC-API-MODEL-schema-oti80oaqc4#response-field-featuredweightfeaturedWeight | string (int64) | Optional | Provider weight used to order featured apps. Pattern: ^-?\d+$. |
Values of authType
Section ID: DOC-API-MODEL-schema-oti80oaqc4#response-values-authtype
Credential mechanism an integration app uses when connecting an account.
| Value | No. | Form | Meaning |
|---|---|---|---|
AUTH_TYPE_KEYS | 0 | Canonical | See meaning below. |
AUTH_TYPE_OAUTH | 1 | Canonical | See meaning below. |
AUTH_TYPE_NONE | 2 | Canonical | See meaning below. |
AUTH_TYPE_KEYS
The app uses API-key credentials.
API keys
AUTH_TYPE_OAUTH
The app uses an OAuth authorization flow.
OAuth 2.0
AUTH_TYPE_NONE
The app does not require authentication credentials.
No auth required
Where used
Section ID: DOC-API-MODEL-schema-oti80oaqc4#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 ID: DOC-API-MODEL-schema-oti80oaqc4