Skip to main content

Service and Action creation

Services are the core components that partners create to enable Snapshot to access and respond to their users' needs. When a service is created, it can have multiple actions associated with it.

Creating a Service​

Partners can create a service by defining its basic information and purpose. This service will act as a container for various actions that can be performed.

Services page​

Services page

Creating a new service​

Creating a new service

Service details​

Service details

Adding Actions to a Service​

Each service can have multiple actions. An action represents a specific operation that can be performed within the service. When creating an action, the following information is required:

  1. Action Name: A descriptive name for the action.
  2. Loader Text (optional): Text to display while the action is loading.
  3. Action Description: A brief explanation of what the action does.
  4. Input Type: The type of input required for the action.
  5. Input Description: A description of the input expected from the user.
  6. Endpoint Method: The HTTP method used for the API call (e.g., GET, POST, PUT, DELETE).
  7. Endpoint: The URL of the API endpoint to be called.
  8. Headers (if any): Any additional headers required for the API call.
  9. Payload (if any): The data to be sent with the request, if applicable.
  10. Response Description: A description of the expected response from the API.

By providing this information for each action, partners can create a comprehensive set of operations that Snapshot can use to interact with their services and fulfill user requests.

Action creation​

Service details