Bixby Developer Center

References

endpoints

required

Defines the endpoints for your actions. The endpoints implement the actual action, taking the action's inputs and returning the expected output. For more information, see Configuring Endpoints.

You can include multiple endpoints.bxb files to support different types of endpoints. They must be placed within your capsule resources folder:

  • Apply to all locales: resources/base/
  • Apply to a specific locale: resources/en-us/

Example

endpoints {

action-endpoints {
action-endpoint (FindShoe) {
accepted-inputs ()
local-endpoint (FindShoe.js)
}

action-endpoint (FindShoeFiltering) {
accepted-inputs (type)
local-endpoint (FindShoeFiltering.js)
}

action-endpoint (FindShoeRemoteEndpoint) {
accepted-inputs ()
remote-endpoint ("https://my-json-server.typicode.com/bixbydevelopers/capsule-samples-collection/shoes") {
method (GET)
}
}

action-endpoint (FindShoeError) {
local-endpoint (FindShoeError.js)
}

action-endpoint (FindShoeReturnHeaders) {
local-endpoint (FindShoeReturnHeaders.js)
}

action-endpoint (CreateShoe) {
local-endpoint (CreateShoe.js)
}
}
}

View master on GitHub

Child Keys

action-endpoints
optional
The outer key for an endpoint, which can contain one or more action-endpoint keys