Module journey.io
ballerinax/journey.io Ballerina library
1.5.2
Overview
The Journey.io API v1.0.0 connector(https://www.journey.io/) OpenAPI specification.
The journy.io API is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Key Features
- Programmatic access to create and manage resources via REST API
- Manage user accounts and profiles
- Secure authentication with API key or OAuth support
Prerequisites
- Create an Journey.io account
- Obtaining tokens
- Use this guide to obtain the API key related to your account
Clients
journey.io: Client
Isolated
This is a generated connector for Journey.io API v1.0.0 OpenAPI specification. The journy.io API is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create a Journy.io account and obtain the API Key following this guide.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.journy.io" - URL of the target service
link
Isolated FunctionRemote Function
function link(LinkBody payload) returns InlineResponse201|errorLink web activity to user
Parameters
- payload LinkBody -
Return Type
- InlineResponse201|error - Object was created
trackJourneyEvent
Isolated FunctionRemote Function
function trackJourneyEvent(EventsBody payload) returns InlineResponse201|errorPush event
Parameters
- payload EventsBody -
Return Type
- InlineResponse201|error - Object was created
upsertUser
Isolated FunctionRemote Function
function upsertUser(UsersUpsertBody payload) returns InlineResponse201|errorCreate or update user
Parameters
- payload UsersUpsertBody -
Return Type
- InlineResponse201|error - Object was created
upsertAccount
Isolated FunctionRemote Function
function upsertAccount(AccountsUpsertBody payload) returns InlineResponse201|errorCreate or update account
Parameters
- payload AccountsUpsertBody -
Return Type
- InlineResponse201|error - Object was created
addUserToAccount
Isolated FunctionRemote Function
function addUserToAccount(string accountId, AccountidUsersBody payload) returns InlineResponse201|errorAdd user to account
Parameters
- accountId string - Unique identifier for the account in your database
- payload AccountidUsersBody -
Return Type
- InlineResponse201|error - Object was created
removeUserFromAccount
Isolated FunctionRemote Function
function removeUserFromAccount(string accountId) returns InlineResponse201|errorRemove user from account
Parameters
- accountId string - Unique identifier for the account in your database
Return Type
- InlineResponse201|error - Object was created
getValidity
Isolated FunctionRemote Function
function getValidity() returns InlineResponse200|errorValidate API key
Return Type
- InlineResponse200|error - Key validation
getTrackingSnippet
Isolated FunctionRemote Function
function getTrackingSnippet(string domain) returns InlineResponse2001|errorGet snippet for a website
Parameters
- domain string - The domain you want to receive a snippet for
Return Type
- InlineResponse2001|error - Snippet
Records
journey.io: AccountidUsersBody
The user being added/removed from the account
Fields
- userId string - Unique identifier for the user in your database
journey.io: AccountsUpsertBody
Update properties and/or members of an account
Fields
- identification EventsIdentificationAccount - Account identification requires an accountId, domain or both
- properties? record {} - The properties being set, possible values are strings, booleans, numbers and datetimes (ISO 8601)
- members? AccountsupsertMembers[] - The users that are member of this account
journey.io: AccountsupsertMembers
Identification requires an accountId, domain or both
Fields
- identification LinkIdentification - User identification requires a userId, email or both
journey.io: ApiKeysConfig
Closed record
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xApiKey string - Represents API Key
X-Api-Key
journey.io: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy? ProxyConfig - Proxy server related options
journey.io: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache? CacheConfig - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
journey.io: EventsBody
Event for a user or an account
Fields
- identification EventsIdentification - Event identification requires a user, account or both
- name string -
- metadata? record {} - Event metadata, possible values are strings, booleans, numbers and datetimes (ISO 8601)
- triggeredAt? string - If left blank this defaults to the current datetime
journey.io: EventsIdentification
Event identification requires a user, account or both
Fields
- account? EventsIdentificationAccount - Account identification requires an accountId, domain or both
- user? LinkIdentification - User identification requires a userId, email or both
journey.io: EventsIdentificationAccount
Account identification requires an accountId, domain or both
Fields
- domain? string - The domain associated with the account (e.g. acme-inc.com)
- accountId? string - Unique identifier for the account in your database
journey.io: InlineResponse200
Fields
- meta InlineResponse201Meta -
- data InlineResponse200Data - Validation of API Key
journey.io: InlineResponse2001
Fields
- meta InlineResponse201Meta -
- data InlineResponse2001Data - A snippet
journey.io: InlineResponse2001Data
A snippet
Fields
- domain string -
- snippet string -
journey.io: InlineResponse200Data
Validation of API Key
Fields
- permissions string[] -
journey.io: InlineResponse201
Fields
- meta InlineResponse201Meta -
- message string -
journey.io: InlineResponse201Meta
Fields
- requestId string -
- status decimal -
journey.io: InlineResponse400
Fields
- message string -
- errors InlineResponse400Errors - Map that sums up all received values that seemed incorrect
journey.io: InlineResponse400Errors
Map that sums up all received values that seemed incorrect
Fields
- fields? record {} - All input fields that seemed incorrect
- parameters? InlineResponse400ErrorsParameters - All query-, header- and path- parameters that seemed incorrect
journey.io: InlineResponse400ErrorsParameters
All query-, header- and path- parameters that seemed incorrect
Fields
- query? record {} -
- header? record {} -
- path? record {} -
journey.io: InlineResponse401
Fields
- meta InlineResponse201Meta -
- message string -
journey.io: LinkBody
Link web activity to user
Fields
- deviceId string -
- identification LinkIdentification - User identification requires a userId, email or both
journey.io: LinkIdentification
User identification requires a userId, email or both
Fields
- email? string - Email address of the user
- userId? string - Unique identifier for the user in your database
journey.io: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
journey.io: UsersUpsertBody
Update properties of a user
Fields
- identification LinkIdentification - User identification requires a userId, email or both
- properties? record {} - The properties being set, possible values are strings, booleans, numbers and datetimes (ISO 8601)