defineLogicFunction
Defina funções de lógica e seus gatilhos
defineLogicFunction
Defina funções de lógica e seus gatilhos
Cada arquivo de função usa Tipos de gatilho disponíveis:O tipo
No seu manipulador, acesse os cabeçalhos encaminhados assim:Por motivos de segurança, os cabeçalhos de resposta são restringidos a uma lista de permissões. Qualquer cabeçalho que não esteja na lista (por exemplo, A função fica acessível em:Ambos os identificadores são os
O valor resolvido deve ser um UUID de workspace válido e seu aplicativo deve estar instalado nesse workspace; caso contrário, a solicitação é rejeitada antes que a função seja executada.A maioria dos provedores assina com HMAC-SHA256; as partes que diferem são o nome do header, a codificação do digest e a string de payload assinada. Alguns exemplos:
O payload inclui:
Para exclusões lógicas, Exemplo de evento de criação:Exemplo de evento de atualização:Disparar somente em atualizações de email:Exemplo de evento de destruição:Pontos-chave:Para declarar seus parâmetros uma vez e atender a ambas as interfaces, defina um único JSON Schema (
defineLogicFunction() para exportar uma configuração com um manipulador e gatilhos opcionais.src/logic-functions/createPostCard.logic-function.ts
- httpRoute: Expõe sua função em um caminho e método HTTP no endpoint
/s/:
por exemplo,path: '/post-card/create'é acessível emhttps://your-twenty-server.com/s/post-card/create
Para invocar uma função de lógica acionada por rota a partir de um componente de front-end (headless), consulte Chamando uma função de lógica.
- cron: Executa sua função em um agendamento usando uma expressão CRON.
- databaseEvent: Executa em eventos do ciclo de vida de objetos do espaço de trabalho. Quando a operação do evento é
updated, campos específicos a serem observados podem ser especificados no arrayupdatedFields. Se deixar indefinido ou vazio, qualquer atualização acionará a função.
por exemplo,person.updated,*.created,company.*
- serverWebhook: Recebe webhooks de entrada de um serviço de terceiros (Stripe, GitHub, Svix, …) em um único endpoint com escopo de registro e resolve o workspace de destino a partir do payload. Veja gatilho de webhook de servidor.
Você também pode executar manualmente uma função usando a CLI:Você pode acompanhar os logs com:
Payload de gatilho de rota
Quando um gatilho de rota invoca sua função de lógica, ela recebe um objetoRoutePayload que segue o formato HTTP API v2 da AWS.
Importe o tipo RoutePayload de twenty-sdk/logic-function:RoutePayload tem a seguinte estrutura:| Propriedade | Tipo | Descrição | Exemplo |
|---|---|---|---|
headers | Record\<string, string | undefined> | Cabeçalhos HTTP (apenas aqueles listados em forwardedRequestHeaders) | veja a seção abaixo |
queryStringParameters | Record\<string, string | undefined> | Parâmetros de query string (valores múltiplos unidos por vírgulas) | /users?ids=1&ids=2&ids=3&name=Alice -> { ids: '1,2,3', name: 'Alice' } |
pathParameters | Record\<string, string | undefined> | Parâmetros de caminho extraídos do padrão de rota | /users/:id, /users/123 -> { id: '123' } |
body | object | null | Corpo da requisição analisado (JSON) | { id: 1 } -> { id: 1 } |
rawBody | string | undefined | Corpo da requisição UTF-8 original, antes da análise de JSON. Útil para verificar assinaturas de webhook no estilo HMAC (por exemplo, X-Hub-Signature-256 do GitHub, Stripe). undefined quando o ambiente de execução não o preservou. | |
isBase64Encoded | boolean | Se o corpo está codificado em base64 | |
requestContext.http.method | string | Método HTTP (GET, POST, PUT, PATCH, DELETE) | |
requestContext.http.path | string | Caminho bruto da requisição |
forwardedRequestHeaders
Por padrão, os cabeçalhos HTTP das requisições recebidas não são repassados para sua função de lógica por motivos de segurança. Para acessar cabeçalhos específicos, liste-os explicitamente no arrayforwardedRequestHeaders:Os nomes dos cabeçalhos são normalizados para minúsculas. Acesse-os usando chaves em minúsculas (por exemplo,
event.headers['content-type']).Resposta HTTP personalizada
Por padrão, retornar um valor simples do seu handler o envia de volta como uma resposta200 (JSON para objetos, text/plain para strings). Para controlar o código de status e os cabeçalhos da resposta, retorne um Response de twenty-sdk/logic-function:Set-Cookie, cabeçalhos CORS como Access-Control-Allow-Origin ou cabeçalhos personalizados X-*) é silenciosamente descartado antes de a resposta ser enviada. Os cabeçalhos de resposta permitidos são:content-typecontent-languagecontent-dispositioncache-controlretry-after
O código de status deve ser um código de status HTTP válido (entre 100 e 599). Os nomes dos cabeçalhos de resposta são comparados sem distinção entre maiúsculas e minúsculas.
Gatilho de webhook do servidor
httpRouteTriggerSettings expõe uma função em /s/ e resolve o workspace a partir do host da solicitação — o que funciona quando cada workspace tem seu próprio domínio. Provedores de terceiros, entretanto, entregam os eventos de todos os workspaces para uma URL de webhook. Para esse caso, use serverWebhookTriggerSettings: a função fica acessível em um endpoint com escopo de registro e o workspace é resolvido a partir do payload.src/logic-functions/handle-provider-webhook.logic-function.ts
universalIdentifiers do seu manifesto — o da aplicação registrada e o desta função de lógica. Registre essa URL junto ao provedor.Resolução de workspace. Como um endpoint atende a todos os workspaces, sua integração deve colocar o workspaceId de destino em algum lugar na entrega, e workspaceIdResolver.{ source, path } informa à plataforma onde lê-lo:| Campo | Valores | Notas |
|---|---|---|
source | body | query | header | body lê o JSON já analisado. query é o mais universal — você normalmente controla a URL de callback que registra, então acrescente ?twentyWorkspaceId=…. |
path | caminho com pontos, por exemplo, metadata.twentyWorkspaceId | Restrito a segmentos alfanuméricos / _ / -; chaves de protótipo são rejeitadas. |
| Provedor | Headers a encaminhar | String assinada | Digest |
|---|---|---|---|
| Svix (Recall, Resend, Clerk) | webhook-id, webhook-timestamp, webhook-signature | {id}.{timestamp}.{rawBody} | base64 (o segredo está em base64 após remover whsec_) |
| Stripe | stripe-signature | {timestamp}.{rawBody} | hex |
| GitHub | x-hub-signature-256 | {rawBody} | hex (prefixado com sha256=) |
| Shopify | x-shopify-hmac-sha256 | {rawBody} | base64 |
| Slack | x-slack-signature, x-slack-request-timestamp | v0:{timestamp}:{rawBody} | hex (prefixado com v0=) |
A função é executada sincronamente e o valor que você retorna se torna a resposta HTTP, portanto os provedores veem seu código de status e podem tentar novamente em caso de não 2xx. Mantenha os handlers rápidos — alguns provedores (por exemplo, Slack) atingem timeout em poucos segundos. Como a função é executada antes de a assinatura ser verificada, proteja esse endpoint com rate limiting na sua borda.
Payload do gatilho de evento do banco de dados
Quando um gatilho de evento do banco de dados invoca sua função lógica, ela recebe umDatabaseEventPayload por registro alterado. O payload combina metadados sobre o workspace e o objeto de origem com o evento em nível de registro.| Propriedade | Descrição |
|---|---|
name | Nome do evento, como person.updated. |
workspaceId | Workspace onde o evento aconteceu. |
objectMetadata | Metadados do objeto que foi alterado. |
recordId | ID do registro alterado. |
userId, userWorkspaceId, workspaceMemberId | Campos do autor quando o evento foi causado por um usuário do workspace. |
properties | Dados do registro para o evento, com before, after, diff e updatedFields, dependendo da operação. |
| Evento | Dados do registro |
|---|---|
person.created | event.properties.after |
person.updated | event.properties.before, event.properties.after, event.properties.diff, event.properties.updatedFields |
person.destroyed | event.properties.before |
.deleted segue o formato de atualização porque o campo deletedAt do registro é alterado.
Para exclusões permanentes, use .destroyed.databaseEventTriggerSettings.updatedFields filtra quais eventos de atualização disparam a função.
event.properties.updatedFields informa quais campos realmente foram alterados no evento atual.Expor uma função como ferramenta de IA ou como ação de fluxo de trabalho
As funções de lógica podem ser expostas em duas superfícies, cada uma com seu próprio gatilho:toolTriggerSettings— torna a função disponível para os recursos de IA do Twenty (chat, MCP, chamadas de função). Usa o JSON Schema padrão, o formato que os LLMs entendem nativamente.workflowActionTriggerSettings— torna a função visível como uma etapa no construtor visual de fluxos de trabalho. Usa oInputSchemaavançado do Twenty para que o construtor possa renderizar editores de campo adequados, seletores de variáveis e rótulos.
cronTriggerSettings, databaseEventTriggerSettings e httpRouteTriggerSettings — mesmo padrão, mesmo formato.src/logic-functions/enrich-company.logic-function.ts
- Uma função pode misturar superfícies — declare tanto
toolTriggerSettingsquantoworkflowActionTriggerSettingspara expô-la no chat E no construtor de fluxos de trabalho. toolTriggerSettings.inputSchemaeworkflowActionTriggerSettings.inputSchemasão opcionais. Quando omitidos, o construtor de manifestos os infere a partir do código-fonte do handler (JSON Schema para a ferramenta de IA,InputSchemado Twenty para a ação de fluxo de trabalho). Forneça um explicitamente quando quiser uma tipagem mais rica — por exemplo, com campos compatíveis comFieldMetadataType, comoCURRENCYouRELATIONpara o construtor de fluxos de trabalho, ou com camposdescriptionque o agente de IA pode ler:
InputJsonSchema) e converta-o para a ação de fluxo de trabalho com jsonSchemaToInputSchema de twenty-sdk/logic-function. toolTriggerSettings.inputSchema recebe o JSON Schema diretamente, enquanto workflowActionTriggerSettings.inputSchema espera o InputSchema da Twenty:Escreva uma boa
description. Os agentes de IA dependem do campo description da função para decidir quando usar a ferramenta. Seja específico sobre o que a ferramenta faz e quando ela deve ser chamada.Auxiliares de tempo de execução.
twenty-sdk/utils reexporta pequenos auxiliares de tempo de execução para que os handlers nunca importem diretamente de twenty-shared. Por exemplo, isDefined(value) retorna false tanto para null quanto para undefined — use-o para restringir com segurança entradas opcionais de handlers, que podem chegar como null em tempo de execução mesmo quando tipadas como T | undefined:Hooks de instalação — manipuladores de pré-instalação e pós-instalação — compartilham esse ambiente de execução, mas são declarados com suas próprias funções de definição e não usam configurações de gatilho. Veja Hooks de instalação para
definePreInstallLogicFunction e definePostInstallLogicFunction.Clientes de API tipados (twenty-client-sdk)
O pacotetwenty-client-sdk fornece dois clientes GraphQL tipados para interagir com a API do Twenty a partir das suas funções de lógica e componentes de front-end.
| Cliente | Importar | Endpoint | Gerado? |
|---|---|---|---|
CoreApiClient | twenty-client-sdk/core | /graphql — dados do espaço de trabalho (registros, objetos) | Sim, em tempo de dev/build |
MetadataApiClient | twenty-client-sdk/metadata | /metadata — configuração do espaço de trabalho, upload de arquivos | Não, vem pré-compilado |
CoreApiClient
Consultar e modificar dados do espaço de trabalho (registros, objetos)
CoreApiClient
Consultar e modificar dados do espaço de trabalho (registros, objetos)
CoreApiClient é o cliente principal para consultar e mutar dados do espaço de trabalho. Ele é gerado a partir do schema do seu espaço de trabalho durante yarn twenty dev ou yarn twenty dev:build, então é totalmente tipado para corresponder aos seus objetos e campos.true para incluir um campo, use __args para argumentos e aninhe objetos para relações. Você tem preenchimento automático e verificação de tipos completos com base no schema do seu espaço de trabalho.CoreApiClient é gerado em tempo de dev/build. Se você usá-lo sem executar primeiro
yarn twenty dev ou yarn twenty dev:build, ele lançará um erro. A geração ocorre automaticamente — a CLI analisa o schema GraphQL do seu espaço de trabalho e gera um cliente tipado usando @genql/cli.Usando CoreSchema para anotações de tipo
CoreSchema fornece tipos TypeScript que correspondem aos objetos do seu espaço de trabalho — útil para tipar o estado de componentes ou parâmetros de função:MetadataApiClient
Configuração do espaço de trabalho, aplicativos e upload de arquivos
MetadataApiClient
Configuração do espaço de trabalho, aplicativos e upload de arquivos
MetadataApiClient é fornecido pré-compilado com o SDK (não é necessário gerar). Ele consulta o endpoint /metadata para configuração do espaço de trabalho, aplicativos e upload de arquivos.Carregamento de arquivos
MetadataApiClient inclui um método uploadFile para anexar arquivos a campos do tipo arquivo:| Parâmetro | Tipo | Descrição |
|---|---|---|
fileBuffer | Buffer | O conteúdo bruto do arquivo |
filename | string | O nome do arquivo (usado para armazenamento e exibição) |
contentType | string | Tipo MIME (padrão para application/octet-stream se omitido) |
fieldMetadataUniversalIdentifier | string | O universalIdentifier do campo do tipo de arquivo no seu objeto |
- Usa o
universalIdentifierdo campo (não o ID específico do espaço de trabalho), de modo que seu código de upload funcione em qualquer espaço de trabalho onde seu aplicativo esteja instalado. - A
urlretornada é uma URL assinada que você pode usar para acessar o arquivo enviado.
Quando seu código é executado no Twenty (funções de lógica ou componentes de front-end), a plataforma injeta credenciais como variáveis de ambiente:
TWENTY_API_URL— URL base da API do TwentyTWENTY_APP_ACCESS_TOKEN— Chave de curta duração com escopo para o papel de função padrão do seu aplicativo
process.env automaticamente. As permissões da chave de API são determinadas pelo papel declarado com defineApplicationRole() (ou referenciado via defaultRoleUniversalIdentifier em application-config.ts).