How to validate the required arguments for a trigger

E

empeOP•1/22/24, 11:32 AM

As for the "Workflow response object", I guess you refer to the JSON object you receive when calling this API endpoint:
https://docs.novu.co/api-reference/workflows/get-workflows

In Novu's terminology, we have:

workflowId

workflowId

workflowId

workflowId - This is a MongoDB-generated identifier within the Novu system that serves as a unique identifier for workflows. It is used in several API endpoints, including the GET Workflow API, and cannot be modified or altered once generated.

WORKFLOW_TRIGGER_IDENTIFIER

WORKFLOW_TRIGGER_IDENTIFIER

WORKFLOW_TRIGGER_IDENTIFIER

WORKFLOW_TRIGGER_IDENTIFIER- This is a unique label used to activate or trigger a workflow in Novu.
It is typically represented in a slugified format and can be modified if necessary.

Novu generates this identifier automatically based on the workflow’s name, and it is utilized in Novu API calls to trigger notifications associated with a specific workflow.

As for how you can obtain the

workflowId

workflowId

workflowId

workflowId there are two ways:

By calling
```
Get Workflows API
```
Get Workflows API
```
Get Workflows API
```
Get Workflows API

To obtain the workflowId
workflowId
workflowId
workflowId, you can call the Get Workflows API which will return a list of workflows including their respective _id
_id
_id
_id fields, which represent their workflowId
workflowId
workflowId
workflowId. Here's an example of how to use the Get Workflows API:

curl --request GET \
  --url https://api.novu.co/v1/workflows \
  --header 'Authorization: <authorization>'

curl --request GET \
  --url https://api.novu.co/v1/workflows \
  --header 'Authorization: <authorization>'

curl --request GET \
  --url https://api.novu.co/v1/workflows \
  --header 'Authorization: <authorization>'

curl --request GET \
  --url https://api.novu.co/v1/workflows \
  --header 'Authorization: <authorization>'

The response from this endpoint will contain an array of workflows, where each workflow object includes an _id
_id
_id
_id field that is the workflowId
workflowId
workflowId
workflowId. You can find this in the JSON response under the "data"
"data"
"data"
"data" array:

{
  "data": [
    {
      "_id": "64f07ea63f28d769494bd74a",
      "name": "Chat with Novu",
      ...
    },
    ...
  ]
}

{
  "data": [
    {
      "_id": "64f07ea63f28d769494bd74a",
      "name": "Chat with Novu",
      ...
    },
    ...
  ]
}

{
  "data": [
    {
      "_id": "64f07ea63f28d769494bd74a",
      "name": "Chat with Novu",
      ...
    },
    ...
  ]
}

{
  "data": [
    {
      "_id": "64f07ea63f28d769494bd74a",
      "name": "Chat with Novu",
      ...
    },
    ...
  ]
}

In this JSON response, "64f07ea63f28d769494bd74a"
"64f07ea63f28d769494bd74a"
"64f07ea63f28d769494bd74a"
"64f07ea63f28d769494bd74a" is an example of a workflowId
workflowId
workflowId
workflowId.

From the workflow's URL

Example:
https://web.novu.co/workflows/edit/64b10dd62d4f4db63503a0a2

In this URL,

64b10dd62d4f4db63503a0a2

64b10dd62d4f4db63503a0a2

64b10dd62d4f4db63503a0a2

64b10dd62d4f4db63503a0a2 is

templateId

templateId

templateId

templateId /

workflowId

workflowId

workflowId

workflowId

How to validate the required arguments for a trigger

Call the Get Workflow API endpoint.

E

empeOP•1/22/24, 11:36 AM

C

CrimsonKobalt•1/22/24, 1:50 PM

Hi @Emil, that confirms what I was trying, thanks a lot! A further question: in the web-interface, it is currently possible to mark arguments on triggers as "required" (i.e. not all arguments are by definition required), however in the API there seems to be no distinction between required and optional arguments. Is that correct?

C

CrimsonKobalt•1/22/24, 1:54 PM

I've enclosed a dummy workflow in the UI and the GetWorkflow API's corresponding response :

{
  "_id": "65ae465d2e7b311203329764",
  "name": "test-providers",
  ...
  "triggers": [
    {
      "type": "event",
      "identifier": "test-providers",
      "variables": [
        {
          "name": "uuid",
          "type": "String",
          "_id": "65ae6ead2e7b31120338a4c4"
        }
      ],
      "reservedVariables": [],
      "subscriberVariables": [],
      "_id": "65ae465d2e7b311203329765"
    }
  ],
  ...
}

{
  "_id": "65ae465d2e7b311203329764",
  "name": "test-providers",
  ...
  "triggers": [
    {
      "type": "event",
      "identifier": "test-providers",
      "variables": [
        {
          "name": "uuid",
          "type": "String",
          "_id": "65ae6ead2e7b31120338a4c4"
        }
      ],
      "reservedVariables": [],
      "subscriberVariables": [],
      "_id": "65ae465d2e7b311203329765"
    }
  ],
  ...
}

{
  "_id": "65ae465d2e7b311203329764",
  "name": "test-providers",
  ...
  "triggers": [
    {
      "type": "event",
      "identifier": "test-providers",
      "variables": [
        {
          "name": "uuid",
          "type": "String",
          "_id": "65ae6ead2e7b31120338a4c4"
        }
      ],
      "reservedVariables": [],
      "subscriberVariables": [],
      "_id": "65ae465d2e7b311203329765"
    }
  ],
  ...
}

{
  "_id": "65ae465d2e7b311203329764",
  "name": "test-providers",
  ...
  "triggers": [
    {
      "type": "event",
      "identifier": "test-providers",
      "variables": [
        {
          "name": "uuid",
          "type": "String",
          "_id": "65ae6ead2e7b31120338a4c4"
        }
      ],
      "reservedVariables": [],
      "subscriberVariables": [],
      "_id": "65ae465d2e7b311203329765"
    }
  ],
  ...
}

CCrimsonKobalt I've enclosed a dummy workflow in the UI and the GetWorkflow API's corresponding...

E

empeOP•1/22/24, 2:00 PM

Have you marked arguments as "required" for this workflow?

C

CrimsonKobalt•1/22/24, 2:01 PM

The API response does not change depending on whether or not I mark the dummy argument as required

N

Novu_Bot•1/22/24, 2:01 PM

@CrimsonKobalt, you just advanced to level 1!

CCrimsonKobalt The API response does not change depending on whether or not I mark the dummy ar...

E

empeOP•1/22/24, 2:04 PM

I'm reproducing this and coming back to you

G

Gali Baum•1/22/24, 2:09 PM

If you use the get workflow api endpoint, in the response you will see that they are required

G

Gali Baum•1/22/24, 2:10 PM

inside the template part, not in the trigger

C

CrimsonKobalt•1/22/24, 2:16 PM

Ah I see, and it seems that section is only present in the 'get workflow' (by id) call, and not the 'get workflows' call. OK, thanks!

G

Gali Baum•1/22/24, 2:16 PM

I mean this part of the response

E

empeOP•1/22/24, 2:17 PM

Ohhh thank you @Gali Baum!!!!

P

Pawan Jain•1/30/24, 7:30 AM

Thanks Gali

P

Pawan Jain•1/30/24, 7:30 AM

@CrimsonKobalt

P

Pawan Jain•1/30/24, 7:30 AM

let me know if you are still facing any issue

How to validate the required arguments for a trigger

By calling `Get Workflows APIGet Workflows API`

From the workflow's URL

How to validate the required arguments for a trigger

Similar Threads

Similar Threads

By calling
`Get Workflows API`
`Get Workflows API`
`Get Workflows API`
`Get Workflows API`

From the workflow's URL

How to validate the required arguments for a trigger

Similar Threads

How to validate the required arguments for a trigger

By calling Get Workflows APIGet Workflows API

From the workflow's URL

How to validate the required arguments for a trigger

Similar Threads

Similar Threads

By calling Get Workflows APIGet Workflows APIGet Workflows APIGet Workflows API

From the workflow's URL

How to validate the required arguments for a trigger

Similar Threads

By calling `Get Workflows APIGet Workflows API`

By calling
`Get Workflows API`
`Get Workflows API`
`Get Workflows API`
`Get Workflows API`