Skip to main content

Skedulo Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Skedulo location.
skedulo_api.png

Skedulo

Create a Skedulo Destination​

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

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

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

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

    Writes a new job record to Skedulo via a GraphQL mutation. Use this endpoint to programmatically create jobs in Skedulo from data flowing through a Nexla pipeline—for example, when integrating a CRM or work order management system that generates new field service requests.

    • This endpoint accepts a JSON-formatted GraphQL mutation payload. The request body should contain a valid Skedulo GraphQL mutation to create a job. Nexla will send the Nexset data formatted as the request body to the Skedulo GraphQL endpoint at https://api.skedulo.com/graphql/graphql (or your regional equivalent).

    • Ensure that the Nexset data is structured to match the expected GraphQL mutation format before sending. A typical GraphQL mutation for creating a job in Skedulo follows this structure:

      • A top-level mutation keyword followed by the mutation name
      • An insert or upsert operation on the Jobs object
      • Required fields such as Name, JobStatus, and Start

    For complete details on required and optional job fields and GraphQL mutation syntax for creating jobs, refer to the Skedulo GraphQL mutations documentation and the Jobs object reference.

    Create Job Allocation

    Writes a job-to-resource allocation record to Skedulo via a GraphQL mutation. Use this endpoint to programmatically assign resources (field workers) to jobs—for example, when an external workforce management or optimization system determines the best resource for each job and sends those assignments back to Skedulo.

    • This endpoint accepts a JSON-formatted GraphQL mutation payload. The request body should contain a valid Skedulo GraphQL mutation to create a job allocation. Required fields include references to the target job UID and the resource UID to be allocated.

    • Ensure that the Nexset data includes valid Skedulo job and resource UIDs, as these are required to create a valid allocation record. UIDs can be obtained using the Get Jobs and Get Resources source endpoints.

    For complete details on required fields and GraphQL mutation syntax for creating job allocations, refer to the Skedulo GraphQL mutations documentation and the JobAllocations object reference.

Configure Manually​

Skedulo destinations can be manually configured to send data to any valid Skedulo API endpoint. The Skedulo API supports both REST-style endpoints (using GET/POST/PUT/DELETE) and GraphQL mutations (using POST with a JSON body). Manual configuration provides full control over the request format and is useful when you need to perform operations beyond what is covered by the pre-built templates.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Skedulo 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 Skedulo API from the Method pulldown menu. Common methods for Skedulo destinations include:

    • POST: For GraphQL mutations (creating or upserting records) and REST endpoints that create new resources
    • PUT: For REST endpoints that perform full replacement updates on existing records
    • PATCH: For REST endpoints that perform partial updates on existing records
    • DELETE: For REST endpoints that remove records

Data Format​

  1. Select the format in which the Nexset data will be sent to the Skedulo API from the Content Format pulldown menu. For Skedulo GraphQL endpoints, select JSON — the Skedulo GraphQL API expects a JSON body with a query or mutation key. Nexla will automatically convert the Nexset data to the selected format for each API call.

API Endpoint URL​

  1. Enter the URL of the Skedulo API endpoint to which you want to send the Nexset data in the URL field. For GraphQL mutations, use the endpoint https://api.skedulo.com/graphql/graphql (or the regional equivalent for your tenant). For REST-style write operations, consult the Skedulo API reference for the appropriate endpoint path.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (for example, Content-Type:application/json). For Skedulo GraphQL endpoints, the Content-Type: application/json header is required and should be included here if it is not automatically set.

    You do not need to include the Authorization header — this is handled automatically by Nexla based on your Skedulo credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Skedulo destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Response Webhook​

Optional

Nexla can automatically send the response received from the Skedulo API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call — for example, the UID of a newly created job record returned in the GraphQL mutation response.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Skedulo API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Skedulo API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Skedulo API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to Skedulo, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to Skedulo until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.