Skip to content

readme #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 3, 2024
Merged

readme #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45fa1f8
Fix imports in readme
pashabitz Oct 3, 2024
e5ddf7a
Fix readme
pashabitz Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Send and receive SMS messages in your Convex app using Twilio.

```ts
import Twilio from "@convex-dev/twilio";
import { components } from "./_generated/server.js";
import { components } from "./_generated/api";

export const twilio = new Twilio(components.twilio, {
default_from: process.env.TWILIO_PHONE_NUMBER!,
Expand Down Expand Up @@ -45,9 +45,9 @@ npm install @convex-dev/twilio
Create a `convex.config.ts` file in your app's `convex/` folder and install the component by calling `use`:

```ts
// convex/convex.config.js
// convex/convex.config.ts
import { defineApp } from "convex/server";
import twilio from "@convex-dev/twilio/convex.config.js";
import twilio from "@convex-dev/twilio/convex.config";

const app = defineApp();
app.use(twilio);
Expand All @@ -67,7 +67,7 @@ Instantiate a Twilio Component client in a file in your app's `convex/` folder:
```ts
// convex/example.ts
import Twilio from "@convex-dev/twilio";
import { components } from "./_generated/server.js";
import { components } from "./_generated/api";

export const twilio = new Twilio(components.twilio, {
// optionally pass in the default "from" phone number you'll be using
Expand Down Expand Up @@ -163,7 +163,9 @@ const twilio = new Twilio(components.twilio, {
twilio.incomingMessageCallback = internal.example.handleIncomingMessage;

export const handleIncomingMessage = internalMutation({
args: messageValidator,
args: {
message: messageValidator,
},
handler: async (ctx, message) => {
// Use ctx here to update the database or schedule other actions.
// This is in the same transaction as the component's message insertion.
Expand Down