Add support for CustomerNeed entity (Create, Trigger)

[guillaumelachaud]

Adding support for CustomerNeed entity (Create, Trigger).

[linear]

USP-7518 Add Trigger and Create for `CustomerNeed`

[guillaumelachaud]

customerId and customerExternalId, as well as attachmentId and attachmentUrl are mutually exclusive. This is enforced at the GraphQL level but didn't see any good way to specify field constraints in the docs unless we want to go down the road of having dynamic fields. Not sure if it's worth the added complexity 🤔

[leelasn]

You could throw an error before hitting our API in createCustomerNeedRequest if both fields are set?

[guillaumelachaud]

Yes, that's probably the best option. I added some checks in createCustomerNeedRequest:

Before	After

Ideally, we would improve on the error parsing in order to relay all GraphQL validation errors. I will follow-up on that as we might want to make this error handling a bit more generic in order to benefit other Zapier creates.

Error payload

{
  "errors": [
    {
      "message": "Argument Validation Error",
      "path": [
        "customerNeedCreate"
      ],
      "locations": [
        {
          "line": 1,
          "column": 80
        }
      ],
      "extensions": {
        "code": "BAD_USER_INPUT",
        "validationErrors": [
          {
            "target": {
              "customerId": "5ae1a484-af7e-48aa-b32e-3d327ec599eb",
              "issueId": "28bf8fe5-5aac-4a1d-9fd0-057a1e9d6fdd",
              "attachmentId": "12",
              "body": "Content of the request",
              "attachmentUrl": "https://"
            },
            "value": "12",
            "property": "attachmentId",
            "children": [],
            "constraints": {
              "isUuid": "attachmentId must be a UUID"
            }
          },
          {
            "target": {
              "customerId": "5ae1a484-af7e-48aa-b32e-3d327ec599eb",
              "issueId": "28bf8fe5-5aac-4a1d-9fd0-057a1e9d6fdd",
              "attachmentId": "12",
              "body": "Content of the request",
              "attachmentUrl": "https://"
            },
            "value": "https://",
            "property": "attachmentUrl",
            "children": [],
            "constraints": {
              "customValidation": "attachmentUrl is not a valid URL"
            }
          }
        ],
        "type": "graphql error",
        "userError": true,
        "exception": {
          "message": "Argument Validation Error",
          "locations": [
            {
              "line": 1,
              "column": 80
            }
          ],
          "path": [
            "customerNeedCreate"
          ],
          "extensions": {
            "code": "BAD_USER_INPUT",
            "validationErrors": [
              {
                "target": {
                  "customerId": "5ae1a484-af7e-48aa-b32e-3d327ec599eb",
                  "issueId": "28bf8fe5-5aac-4a1d-9fd0-057a1e9d6fdd",
                  "attachmentId": "12",
                  "body": "Content of the request",
                  "attachmentUrl": "https://"
                },
                "value": "12",
                "property": "attachmentId",
                "children": [],
                "constraints": {
                  "isUuid": "attachmentId must be a UUID"
                }
              },
              {
                "target": {
                  "customerId": "5ae1a484-af7e-48aa-b32e-3d327ec599eb",
                  "issueId": "28bf8fe5-5aac-4a1d-9fd0-057a1e9d6fdd",
                  "attachmentId": "12",
                  "body": "Content of the request",
                  "attachmentUrl": "https://"
                },
                "value": "https://",
                "property": "attachmentUrl",
                "children": [],
                "constraints": {
                  "customValidation": "attachmentUrl is not a valid URL"
                }
              }
            ]
          }
        }
      }
    }
  ],
  "data": null

[Sophie1142]

Hello, is CustomerNeed the same as Linear's Customer Request?

[guillaumelachaud]

Yes. You can find more documentation about the Customers data models here.