1. Webhooks
  • Introdução
    • Comece Aqui
    • Autenticação
    • Recursos
  • API
    • Enterprise
      • Overview
      • Create
      • Show
      • Update
      • Delete
      • Index
      • Profile
    • Company
      • Overview
      • Create
      • Show
      • Update
      • Delete
      • Index
    • Order
      • Overview
      • Create
      • Show
      • Update
      • Delete
      • Index
      • Search external
    • Customer
      • Create
      • Show
      • Update
      • Delete
      • Index
      • Validate phone
      • Blocked (batch)
      • Search individual
      • Search external
      • Track Record
      • Point
    • Withdrawal
      • Rescue
      • Reactivate
      • Show
      • Delete
      • Index
      • Search available
      • Quantity
      • Quantity Company (Monthly)
      • Quantity (Last Days)
    • Activation
      • Create
      • Update
      • Show
      • Delete
    • Promotion
      • Create
      • Update
      • Show
      • Delete
      • Index
    • Submission
      • Index
      • Show
      • Delete
    • Individual
      • Create
      • Index
      • Delete
    • Campaign
      • Create
      • Show
      • Update
      • Delete
      • Index
    • Profile
      • Profile
      • Update profile
      • Update password profile
      • Inactivate
    • User
      • Create
      • Show
      • Update
      • Delete
      • Index
    • Role
      • Create
      • Index
    • Permission
      • Create
      • Index
      • Delete
      • Show
      • Update
    • Status
      • Create
      • Index
      • Update
      • Delete
    • Tag
      • Create
      • Index
      • Update
      • Delete
    • Segment
      • Create
      • Show
      • Update
      • Delete
      • Index
      • Pre Query Builder Segment
    • Product
      • Create
      • Show
      • Update
      • Delete
      • Index
      • Search external
      • Quantity
      • Quantity Sale Product Enterprise
      • Quantity Sale Product Enterprise (Monthly)
    • Webhooks
      • Overview
      • Create
        POST
      • Index
        GET
      • Delete
        DELETE
    • Billing
      • Quota
      • Index
      • Show
    • User Access Pin
      • Request
      • Revalidate
    • Target
      • Create
      • Delete
    • Redeem
      • Create
      • Index
    • Reward
      • Create
      • Index
      • Update
      • Delete
      • Show
      • Update active
    • Subscription
      • Index
      • Webhook Asaas
    • Payment Profile
      • Index
      • Update
  1. Webhooks

Overview

Webhooks são utilizados para monitorar ações que acontecem dentro da StoryCRM. A criação de webhooks só pode ser feita via API.

Endpoints.#

Create | Index | Delete

CREATE WEBHOOK#

Um webhook é criado através do endpoint:
https://api.storycrm.app/v1/webhooks/preference

Parâmetros para criação de um Webhook#

ParâmetroDescricãoTipoObrigatório
enterprise_idId único da enterprise na qual o webhook está vinculadostringSim
callback_urlURL para qual o webhook irá enviar o payload de informaçõesstringSim
callback_authInformação de autenticação para acessar o conteúdo do webhookstringNão
eventEvento dentro da plataforma que irá disparar o webhookstringSim

Eventos#

EventoDescrição
ORDER_CREATEDDispara assim que uma order é criada.
ORDER_CASHBACK_USEDDispara assim que um cashback é resgatado
ORDER_CASHBACK_REACTIVATEDDispara assim que um cashback é reativado.
CUSTOMER_CREATEDDispara assim que um novo cliente é criado.
CUSTOMER_UPDATEDDispara assim que um novo cliente é atualizado.
CAMPAIGN_CREATEDDispara assim que uma nova campanha é criada.
CAMPAIGN_INDIVIDUAL_CREATEDDispara assim que uma nova campanha individual é criada.
CAMPAIGN_SEGMENT_CREATEDDispara assim que uma nova segmentação é criada.
PRODUCT_CREATEDDispara assim que umnovo produto é criado.
STRATEGY_PROMOTION_CREATEDDispara assim que uma nova estratégia é criada.
STRATEGY_REWARD_CREATEDDispara assim que uma nova recompensa é criada.
Modificado em 2025-10-16 20:07:55
Página anterior
Quantity Sale Product Enterprise (Monthly)
Próxima página
Create
Built with