Skip to main content

Gem API Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to a Gem API location.
gem_api.png

Gem API

Create a Gem API Destination​

  1. Click the + icon on the Nexset that will be sent to the Gem API destination, and select the Send to Destination option from the menu.

  2. Select the Gem API connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Gem API organization, and click Next; or, create a new Gem API credential for use in this flow.

  3. In Nexla, Gem API destinations can be created using pre-built endpoint templates, which expedite destination setup for common Gem API endpoints. Each template is designed specifically for the corresponding Gem API endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Gem API destinations can also be configured manually, allowing you to send data to Gem API endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Gem API endpoints. Each template is designed specifically for the corresponding Gem API endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create Candidate/Note/Project/Project Fields

    Create new candidate/Note/Project/Project Fields.

    • Select the type of resource to create from the Candidate/Note/Project/Project Fields dropdown menu. Available options are:

      • Candidates: Create a new candidate
      • Notes: Create a new note
      • Projects: Create a new project
      • Project Fields: Create a new project field
    • The endpoint uses POST requests to https://api.gem.com/v0/{event_type} where {event_type} is the Candidate/Note/Project/Project Fields type you select. The endpoint URL is automatically constructed based on the Gem API base URL and the selected resource type.
    • The endpoint sends data from your Nexset as the request body in JSON format. The request body is automatically formatted according to the schema fields and data mapping you configure. Each record in your Nexset will be sent as a JSON object containing the resource data to create.
    • Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a resource. If you need to create multiple resources, you can send multiple records, but each will be processed as a separate request.
    • This endpoint does not automatically create a data source to track the responses received from the Gem API after each call.

    The resource type determines which endpoint is used: candidates, notes, projects, or project fields. The request body must be properly formatted JSON that matches the Gem API specification for creating the selected resource type. The endpoint requires API Key authentication via the X-API-Key header, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating candidates, notes, projects, or project fields, including required fields, field names, and request formats, see the Gem API documentation.

    Modify Candidate

    Modifies a candidate based on ID. Only the fields included in the request argument will be modified.

    • Enter the ID of the candidate you want to modify in the Candidate ID field. This should be a valid candidate ID from your Gem account.

    • The endpoint uses PUT requests to https://api.gem.com/v0/candidates/{candidate_id} where {candidate_id} is the Candidate ID you provide. The endpoint URL is automatically constructed based on the Gem API base URL and the candidate ID.
    • The endpoint sends data from your Nexset as the request body in JSON format. The request body is automatically formatted according to the schema fields and data mapping you configure. Each record in your Nexset will be sent as a JSON object containing the candidate fields to modify.
    • Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to modify a candidate. If you need to modify multiple candidates, you can send multiple records, but each will be processed as a separate request.
    • This endpoint does not automatically create a data source to track the responses received from the Gem API after each call.

    Candidate IDs should be valid IDs from your Gem account. Only the fields included in the request body will be modified; other fields will remain unchanged. The request body must be properly formatted JSON that matches the Gem API specification for modifying candidates. The endpoint requires API Key authentication via the X-API-Key header, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about modifying candidates, including required fields, field names, and request formats, see the Gem API documentation.

Configure Manually​

Gem API destinations can be manually configured to send data to any valid Gem API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Gem API destinations, such as destinations that use custom request headers, different HTTP methods, or custom data formatting.

Content Format​

  1. Select the format in which the Nexset data will be sent to the Gem API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The Gem API typically uses JSON format for request bodies.

API Endpoint URL​

  1. Enter the URL of the Gem API endpoint to which you want to send the Nexset data in the URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Gem API endpoints typically follow the pattern https://api.gem.com/v0/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires API Key authentication via the X-API-Key header, which is handled automatically by your credential configuration. For detailed information about Gem API endpoints and available APIs, see the Gem API documentation.