Novu•2mo ago

Workflow transaction id availability

Can we access transaction id for which workflow is being executed in SDK for logging/debugging purpose? Transaction id is response id for this API: https://docs.novu.co/api-reference/events/events-controller_trigger

Trigger event | Novu Documentation

Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Additional information can be passed according the body interface below.

15 Replies

Pawan Jain•2mo ago

@Vivek I am not sure I understand your requirement This above api returns transactionid in response

VivekOP•2mo ago

We use trigger API to execute workflow and it returns transactionId in response and we use SDK for workflow execution where we want to access this transaction id in that SDK so that we can log and reuse id wherever needed.

VivekOP•2mo ago

I'm referring to this workflow code - https://docs.novu.co/framework/typescript/workflow

Workflow | Novu Documentation

Learn about the Novu Framework workflow interface and its configuration options

Pawan Jain•2mo ago

@Vivek I am still not sure, I understood how you want to use transactionId with framework workflow

VivekOP•2mo ago

- Workflow - we've created workflow in NodeJS similar to this - https://github.com/novuhq/examples/tree/main/novu-workflows/react/otp - where we're triggering steps as configured in workflow - before passing payload params to flow we need to log subscriber to transaction mapping to know that transaction which is triggered using API is flowing through workflow - Use cases - Debugging on triggerring workflow to executing - Logging transactionId along with workflow execution step id

GitHub

examples/novu-workflows/react/otp at main · novuhq/examples

Contribute to novuhq/examples development by creating an account on GitHub.

Pawan Jain•2mo ago

If I am correct, you are looking to log transaction id in logs? that will be returned in response of api trigger?

VivekOP•2mo ago

import { workflow } from '@novu/framework';
 
workflow(
  'my-workflow',
  async ({ step, payload, subscriber }) => {
    await step.inApp('send-in-app', async () => {
      logger.info(`executing workflow ${name} for transaction ${<<transactionId>>}`);
      return {
        body: 'Hello there',
      };
    });
  },
  {
    payloadSchema: z.object({
      body: z.string(),
    }),
    name: 'My Workflow',
    description: 'This is a workflow',
    tags: ['business', 'critical'],
    preferences: {
      channels: {
        inApp: { enabled: true },
      },
    },
  }
);

import { workflow } from '@novu/framework';
 
workflow(
  'my-workflow',
  async ({ step, payload, subscriber }) => {
    await step.inApp('send-in-app', async () => {
      logger.info(`executing workflow ${name} for transaction ${<<transactionId>>}`);
      return {
        body: 'Hello there',
      };
    });
  },
  {
    payloadSchema: z.object({
      body: z.string(),
    }),
    name: 'My Workflow',
    description: 'This is a workflow',
    tags: ['business', 'critical'],
    preferences: {
      channels: {
        inApp: { enabled: true },
      },
    },
  }
);

Pawan Jain•2mo ago

We suport sending custom transactionId with event trigger method

VivekOP•2mo ago

yes correct

Pawan Jain•2mo ago

import { Novu as NovuNodeClient } from "@novu/node";

const novuNodeClient = new NovuNodeClient("secret_key");

const transactionId = "12345-abcdefgh";

await novuNodeClient.trigger("workflow-id", {
  to: "638e13005e962a70bf4034e1",
  payload: {
    // modilfy it as per your configuration of CTA link
    transactionId,
  },

  // custom transactionId sent by you
  // novu will use this transactionId, it should be unique for each event trigger as we have idempotency based on the transactionId
  transactionId: transactionId,
});

import { Novu as NovuNodeClient } from "@novu/node";

const novuNodeClient = new NovuNodeClient("secret_key");

const transactionId = "12345-abcdefgh";

await novuNodeClient.trigger("workflow-id", {
  to: "638e13005e962a70bf4034e1",
  payload: {
    // modilfy it as per your configuration of CTA link
    transactionId,
  },

  // custom transactionId sent by you
  // novu will use this transactionId, it should be unique for each event trigger as we have idempotency based on the transactionId
  transactionId: transactionId,
});

then you can acces transactionid like this logger.info(executing workflow ${name} for transaction ${payload.transactionId});

VivekOP•2mo ago

Yes this is definitely solves our problem but in this case we need to create logic for generating unique transactionId across workflow triggers. Is this correct? As we're also fetching this transactionId data to validate open info of in-app notification for a user too.

Novu_Bot•2mo ago

@Vivek, you just advanced to level 3!

Pawan Jain•2mo ago

yes, you will have to manage the transactionId generation from your end

VivekOP•2mo ago

Will there be any restriction for generating transactionId apart from being unique? In terms of format, validation etc.

Pawan Jain•2mo ago

length should be less than 256 charracters. alphanumeric string

Gaming

Programming

Workflow transaction id availability

Did you find this page helpful?