Edusign

This is the fastest way to get a connection. The URL is normalized to a domain and matched against known apps. If no app is found, one is created and a connector is built automatically.

If the returned connection has state: "READY", skip to Step 2.

#### 1b. Wait for the connection to be ready

If the connection is in BUILDING state, poll until it's ready:

npx @membranehq/cli connection get  --wait --json

The --wait flag long-polls (up to --timeout seconds, default 30) until the state changes. Keep polling until state is no longer BUILDING.

The resulting state tells you what to do next:

After the user completes the action (e.g. authenticates in the browser), poll again with membrane connection get --json to check if the state moved to READY.

Searching for actions

Search using a natural language description of what you want to do:

membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json

You should always search for actions in the context of a specific connection.

Each result includes id, name, description, inputSchema (what parameters the action accepts), and outputSchema (what it returns).

Popular actions

| Name | Key | Description | |---|---|---| | List Students | list-students | Retrieve all active students. | | List Professors | list-professors | Retrieve all professors | | List Courses | list-courses | Retrieve all courses with optional filtering by date range and status | | List Groups | list-groups | Retrieve all groups | | List Classrooms | list-classrooms | Retrieve all classrooms | | List Trainings | list-trainings | Retrieve all training programs | | List Documents | list-documents | Retrieve all documents | | List Surveys | list-surveys | Retrieve all surveys | | List Survey Templates | list-survey-templates | Retrieve all survey templates | | Get Student by ID | get-student-by-id | Retrieve a student by their Edusign ID | | Get Professor by ID | get-professor-by-id | Retrieve a professor by their Edusign ID | | Get Course by ID | get-course-by-id | Retrieve a course by its Edusign ID | | Get Group by ID | get-group-by-id | Retrieve a group by its Edusign ID | | Get Survey by ID | get-survey-by-id | Retrieve a survey by its ID | | Create Student | create-student | Create a new student in Edusign | | Create Professor | create-professor | Create a new professor in Edusign | | Create Course | create-course | Create a new course/session in Edusign | | Create Group | create-group | Create a new group in Edusign | | Create Classroom | create-classroom | Create a new classroom | | Update Course | update-course | Update an existing course |

Running actions

membrane action run  --connectionId=CONNECTION_ID --json

To pass JSON parameters:

membrane action run  --connectionId=CONNECTION_ID --input '{"key": "value"}' --json

The result is in the output field of the response.

Proxy requests

When the available actions don't cover your use case, you can send requests directly to the Edusign API through Membrane's proxy. Membrane automatically appends the base URL to the path you provide and injects the correct authentication headers — including transparent credential refresh if they expire.

membrane request CONNECTION_ID /path/to/endpoint

Common options:

| Flag | Description | |------|-------------| | -X, --method | HTTP method (GET, POST, PUT, PATCH, DELETE). Defaults to GET | | -H, --header | Add a request header (repeatable), e.g. -H "Accept: application/json" | | -d, --data | Request body (string) | | --json | Shorthand to send a JSON body and set Content-Type: application/json | | --rawData | Send the body as-is without any processing | | --query | Query-string parameter (repeatable), e.g. --query "limit=10" | | --pathParam | Path parameter (repeatable), e.g. --pathParam "id=123" |

Best practices