Skip to main content

Using External Services

How to add 3rd Party Services​

Take a look at the Service Catalog for a list of all available services broken down by category. Simply click on the service you want to use, enter in API keys, and you're ready to start using it. Some services are global, meaning they apply to all requests (eg IP intelligence, device fingerprinting). Others provide specific functionality that gets called in a checkpoint.

To use a service in your checkpoint, open up the checkpoint you want to edit in the Checkpoint Studio and click on the Services tab in the Step Palette. Scroll down to the service you added, then drag and drop the specific functionality you want to use into the checkpoint flow diagram.

note

You may see an alert telling you that the expected input for the checkpoint has changed. This means that the service you added requires additional information to be passed in to the checkpoint. Click on the first step in the checkpoint flow diagram (ie the step with the same name as the checkpoint) to see what data is required. You should then update your code to pass in the required data before publishing the checkpoint.

Using your own API Keys​

By default, Dodgeball comes with a set of included services for which billing is unified and based on usage. Dodgeball includes a generous amount of service calls for free; meaning, you can use these included services without having to negotiate a deal or configure your own API keys in the Trust Console. You'll be billed based on usage over the number of included free calls. However, if you want to use your own API keys, you can do so by following these instructions:

  1. Visit the Service Catalog and click on the service you want to enter your own API keys for.
  2. Under the section labeled Configuration enter any required API keys and click the Save button.

Have a service you'd like to offer through Dodgeball? Contact us to get things started.

Calling Your Internal Services​

You may want to run custom code if:

  • You want to call an in-house fraud model or send information to a data science team.
  • You want to call a service that isn't available in the Service Catalog.
  • You want to trigger some side-effect in your application, such as deactivating a user account, removing a listing, or reversing a transaction.

To call custom code, open up the checkpoint you want to edit in the Checkpoint Studio and click on the Custom tab in the Step Palette. Find the Webhook step, then drag and drop it into the checkpoint flow diagram. Click on the Webhook step to configure it. Here you'll find a few options:

  • URL: The URL of the endpoint you want to call.
  • Method: The HTTP method you want to use to call the endpoint.
  • Description (Optional): A brief description of what the endpoint does.
  • Input Data Mapping (Optional): How you would like to populate the request body sent to the endpoint when the checkpoint is called.
  • Output Data Mapping (Optional): How you would like to parse the response from the endpoint so it can be used in Dodgeball and passed to other services.
info

Important: Make sure you have permission to send requests to any endpoint you call. Webhook calls that repeatedly fail will be disabled to prevent abuse.