Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Request: Public schema for Notify webhook payloads and Custom Webhook GraphQL

Abierto
  • ¿Algo no está bien?
#852 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
graphql, openapi
Área
api, documentation

Línea de trabajo

Empieza localizando la especificación OpenAPI existente de Notify API y revisando cómo están organizados sus componentes. Define componentes oficiales para las envolturas y los cuerpos de evento de los webhooks de Address Activity y NFT Activity, y proporciona después el esquema GraphQL de Custom Webhooks como SDL, JSON de introspección o mediante un endpoint público. Se considera completado cuando los consumidores pueden generar tipos y validar payloads y queries, y cuando está documentada la relación del resultado de GraphQL con el evento del webhook.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Summary

Notify has an OpenAPI spec for managing webhooks, but there is no official, machine-readable schema for:

  • The webhook payloads actually sent to our endpoints
  • The GraphQL schema used by Custom Webhooks

Having these as official schemas would make it much easier to build and validate strongly typed integrations.

Request 1: Schemas for webhook payloads

Provide OpenAPI components for webhook event bodies, especially:

  • Address Activity Webhook
  • NFT Activity Webhook

Suggested scope:

  • Top-level envelope
    • webhookId, id, createdAt, type, event, etc.
  • event object
    • network as an enum (aligned with the existing Notify API OpenAPI)
    • activity[] items with clear required/optional fields, types, and nullability
  • Enum-like fields
    • For example: category values such as external, internal, erc20, erc721, erc1155, token, etc.

These should be provided as OpenAPI components alongside the existing Notify API spec.

Request 2: Schema for Custom Webhooks GraphQL

Provide a way to consume the Custom Webhooks GraphQL schema, for example:

  • SDL file (schema.graphql), or
  • Introspection JSON, or
  • A public endpoint with introspection enabled (even read-only / rate-limited)

This would allow:

  • GraphQL code generation (TypeScript, Go, etc.)
  • IDE autocomplete and static validation for Custom Webhook queries
  • CI validation of GraphQL queries against the real schema

It would also help to document how the GraphQL result is embedded in the webhook payload (relationship between GraphQL data and the event object / top-level envelope).

Motivation

  • We validate incoming webhook requests using JSON Schema / OpenAPI at the edge.
  • We use schema/codegen to generate types for multiple services from a single source of truth.
  • Without official schemas, we have to rely on prose docs and examples, which is fragile when payloads or fields evolve.
Lenguaje dominante
MDX
Estrellas
8
Forks
18
Merge medio
21 h 8 min
PR fusionados (30 d)
45

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de alchemyplatform/docs

Todos los issues de alchemyplatform/docs

Issues similares

Más issues de Backend & API Design

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.