transient payload in registration form (server-side, browser)

[akhayyat]

I'm trying to get additional data in the registration form in my server-side web application using transient payload, as documented in https://www.ory.sh/docs/kratos/bring-your-own-ui/custom-ui-basic-integration and https://www.ory.sh/docs/guides/integrate-with-ory-cloud-through-webhooks.

I have an HTML form input like this:

<input type="text" name="transient_payload.my_field" required="" id="id_transient_payload.my_field">

However, this results in a transient_payload value of {} (empty object).

I've also tried setting the name of the HTML input to just transient_payload:

<input type="text" name="transient_payload" required="" id="id_transient_payload">

which results in the error: Error: Unable to decode JSON payload. Also, this would not allow me to control the name of the input, or adding additional inputs to be picked up by my webhook.

So, how do I pass additional inputs in the registration form to be picked up by a webhook during registration, without persisting them in Ory?

[vinckr]

Hello @akhayyat

you are using the right feature, that is exactly what transient_payload field is designed for.

To pass additional data to the flow using the optional transient_payload field, you need to include it in the POST request payload when submitting the registration form. This data gets forwarded to webhooks without being persisted by Ory like identity traits do.

If the object is empty or there is a JSON decode error there is probably some issue in your code.
Can you share the full example with steps to reproduce maybe?
I suspect you have some minor issue in your frontend code there.

For example from our tests:

updateRegistrationFlowBody: {
                  method: "password",
                  transient_payload: testPayload,
                },

[akhayyat]

docker compose -f quickstart.yml up --build --force-recreate using a slightly modified version of the quickstart.yml docker compose config in the kratos repository.

image: oryd/kratos:v0.13.0

quickstart.yml:

version: '3.7'
services:
  kratos-migrate:
    image: oryd/kratos:v0.13.0
    environment:
      - DSN=sqlite:///var/lib/sqlite/db.sqlite?_fk=true&mode=rwc
    volumes:
      - type: volume
        source: kratos-sqlite
        target: /var/lib/sqlite
        read_only: false
      - type: bind
        source: ./kratos-config
        target: /etc/config/kratos
    command: -c /etc/config/kratos/kratos.yml migrate sql -e --yes
    restart: on-failure
    networks:
      - intranet
  kratos-selfservice-ui-node:
    image: oryd/kratos-selfservice-ui-node:v0.13.0
    ports:
      - "4455:4455"
    environment:
      - PORT=4455
      - SECURITY_MODE=
      - KRATOS_BROWSER_URL=http://127.0.0.1:4433/
      - KRATOS_PUBLIC_URL=http://kratos:4433/
    networks:
      - intranet
    restart: on-failure
  kratos:
    depends_on:
      - kratos-migrate
    image: oryd/kratos:v0.13.0
    ports:
      - '4433:4433' # public
      - '4434:4434' # admin
    restart: unless-stopped
    environment:
      - DSN=sqlite:///var/lib/sqlite/db.sqlite?_fk=true
      - LOG_LEVEL=trace
    command: serve -c /etc/config/kratos/kratos.yml --dev --watch-courier
    volumes:
      - type: volume
        source: kratos-sqlite
        target: /var/lib/sqlite
        read_only: false
      - type: bind
        source: ./kratos-config
        target: /etc/config/kratos
    networks:
      - intranet
  mailslurper:
    image: oryd/mailslurper:latest-smtps
    ports:
      - '4436:4436'
      - '4437:4437'
    networks:
      - intranet
networks:
  intranet:
volumes:
  kratos-sqlite:

Note: I'm not using kratos-selfservice-ui-node.

[akhayyat]

Is there a bug here, or is this expected behavior? If the latter, how is this supposed to work with HTML forms?

[vinckr]

I havent tried it out but the payload and config you shared looks fine to me.

A couple more ideas:

• Is the data submitted correctly through the form?
• Can you check if everything is correct in the requests in dev tools?
• Can you run a curl command with the same payload that works?

Ory also offers support agreements for things like this, see here.

[MrMebelMan]

@akhayyat any update on this pls? I'm dealing with a similar issue 🙏

[isaqib23]

@akhayyat and @MrMebelMan

I also faced same issue & find when the webhook parses the response, the logic is called before the system creates a new identity. When the webhook does not parse the response, the logic is called after the system creates a new identity.
it seems like the webhook is being triggered before the new identity is fully created, hence the placeholder ID 00000000-0000-0000-0000-000000000000. You might want to adjust your configuration to ensure that the webhook is triggered after the identity is created.
You can do this by setting parse to false in your webhook configuration:

CC: @vinckr