action alertersystem_api_transport_help_scout_id_get { label: "Retrieves a TransportHelpScout resource." description: "Retrieves a TransportHelpScout resource." provider: alertersystem method: GET path: "/api/transport-help-scout/{id}" encoding: json input: { type: "object" properties: { id: { type: "string" } } required: ["id"] additionalProperties: false } output: { type: "object" description: "The TransportHelpScout resource is a collection of transports that carry dispatched alerts to the external HelpScout service." required: ["helpScoutCustomerEmail", "helpScoutOauthToken", "partition", "transportName"] properties: { createdAt: { type: "string" format: "date-time" description: "When the resource instance was created. This date-time is in the UTC timezone." } dataSegmentCode: { type: "string" description: "User-provided string on which to segment and filter data. Max 50 characters." } helpScoutCustomerEmail: { type: "string" format: "email" description: "The requester customer email address for the HelpScout service." } helpScoutMailboxId: { type: "integer" description: "The mailbox ID for the HelpScout service." } helpScoutOauthToken: { type: "string" description: "The OAuth token for the HelpScout service. Stored in encrypted format." } id: { type: "string" format: "uuid" description: "The unique identifier of the resource instance." } partition: { type: "string" format: "iri-reference" description: "The partition that contains this resource instance. The resource cannot be moved to another partition." } resourceOwner: { type: "string" description: "The name of the person who owns this resource." } transportName: { type: "string" description: "The name of the transport." } } } }