Skip to main content

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 Namely location.
namely_api.png

Namely

Create a Namely Destination​

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

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

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

    Namely destinations can also be configured manually, allowing you to send data to Namely 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 Namely endpoints. Each template is designed specifically for the corresponding Namely 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 A Resource

    This endpoint template creates a new resource in your Namely account. Use this template when you need to create new resources such as announcements, events, profiles, or other Namely resources. The endpoint sends data as JSON in the request body to create the new resource.

    • Enter the resource type in the Resource Type field. This should be the resource type you want to create (e.g., announcements, events, profiles). The resource type determines which type of Namely resource will be created. Refer to the Namely API documentation for available resource types and their required fields.

    This endpoint sends data as JSON in the request body to create a new resource in your Namely account. The request body should contain the resource data in JSON format, with field names matching the Namely API's expected structure for the specified resource type. The endpoint returns the created resource with its assigned ID and other generated fields.

    For detailed information about creating resources, available resource types, required fields, and request body formats, see the Namely API documentation.

    Update A Resource

    This endpoint template updates an existing resource in your Namely account by resource ID. Use this template when you need to update existing resources such as profiles, events, or other Namely resources. The endpoint sends data as JSON in the request body to update the specified resource.

    • Enter the resource type in the Resource Type field. This should be the resource type you want to update (e.g., profiles, events, groups). The resource type determines which type of Namely resource will be updated. Refer to the Namely API documentation for available resource types and their updatable fields.
    • Enter the resource ID in the Resource ID field. This is the unique identifier of the resource you want to update. The resource ID is typically a numeric or alphanumeric identifier that uniquely identifies the resource within the specified resource type.

    This endpoint sends data as JSON in the request body to update an existing resource in your Namely account. The request body should contain the resource data in JSON format, with field names matching the Namely API's expected structure for the specified resource type. Only fields included in the request body will be updated; other fields will remain unchanged.

    For detailed information about updating resources, available resource types, updatable fields, and request body formats, see the Namely API documentation.

Configure Manually​

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

Using manual configuration, you can also configure Nexla to automatically send the response received from the Namely API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Namely API from the Method pulldown menu. Namely API typically uses POST method for creating resources, PUT method for updating resources, and PATCH method for partial updates.

Data Format​

  1. Select the format in which the Nexset data will be sent to the Namely API from the Content Format pulldown menu. Namely API expects JSON format for all requests.

API Endpoint URL​

  1. Enter the URL of the Namely API endpoint to which data will be sent in the URL field. This should be the complete URL including your company name (from your credential), the API path (e.g., /api/v1/profiles), and any required query parameters (e.g., https://acme.namely.com/api/v1/profiles). For update operations, include the resource ID in the URL path (e.g., https://acme.namely.com/api/v1/profiles/{resource_id}).

Ensure the API endpoint URL is correct and includes the resource type and resource ID (for update operations). The Namely API endpoint URL should point to the resource endpoint where you want to create or update resources. You can test the endpoint using the Test button after configuring the URL.

Request Body​

  1. Configure the request body that will be sent to the Namely API. The request body should contain the resource data formatted as JSON, with field names matching the Namely API's expected structure for the specified resource type. The request body format is typically {message.json} to send the entire Nexset data as JSON, or you can construct a custom JSON structure with specific field mappings.

The request body must be valid JSON and must match the Namely API's expected format for the specified resource type. Field names in the request body must match the Namely API's expected field names. For detailed information about request body formats, available resource types, required fields, and field names, see the Namely API documentation.

Save the Destination​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the destination configuration for later use.