Conexión de CRM por webhook

cURL

# o segredo da conexão (whsec_…), usado como está
SECRET="whsec_..."
URL="https://api.postal.so/integrations/crm/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/webhook"
BODY='{"email":"[email protected]","first_name":"Ana"}'

SIGNATURE="sha256=$(printf '%s' "$BODY" | openssl dgst -sha256 -hmac "$SECRET" | sed 's/^.* //')"

curl -X POST "$URL" \
  -H "Content-Type: application/json" \
  -H "X-Postal-Signature: $SIGNATURE" \
  -d "$BODY"

Node.js

import crypto from 'node:crypto';

const secret = process.env.POSTAL_CRM_SECRET; // o segredo da conexão (whsec_…), usado como está
const body = JSON.stringify({ email: '[email protected]', first_name: 'Ana' }); // exatamente os bytes que você envia
const signature = 'sha256=' + crypto.createHmac('sha256', secret).update(body).digest('hex');

const response = await fetch(process.env.POSTAL_CRM_WEBHOOK_URL, {
  method: 'POST',
  headers: { 'Content-Type': 'application/json', 'X-Postal-Signature': signature },
  body,
});
// 202 { "object": "crm_webhook", "id": "...", "status": "accepted" }

Python

import hashlib
import hmac
import json
import os

import requests

secret = os.environ["POSTAL_CRM_SECRET"]  # o segredo da conexão (whsec_…), usado como está
body = json.dumps({"email": "[email protected]", "first_name": "Ana"}).encode()  # exatamente os bytes que você envia
signature = "sha256=" + hmac.new(secret.encode(), body, hashlib.sha256).hexdigest()

response = requests.post(
    os.environ["POSTAL_CRM_WEBHOOK_URL"],
    data=body,
    headers={"Content-Type": "application/json", "X-Postal-Signature": signature},
    timeout=10,
)

PHP

<?php

$secret = getenv('POSTAL_CRM_SECRET'); // o segredo da conexão (whsec_…), usado como está
$body = json_encode(['email' => '[email protected]', 'first_name' => 'Ana']); // exatamente os bytes que você envia
$signature = 'sha256='.hash_hmac('sha256', $body, $secret);

$client = new \GuzzleHttp\Client();
$response = $client->post(getenv('POSTAL_CRM_WEBHOOK_URL'), [
    'headers' => ['Content-Type' => 'application/json', 'X-Postal-Signature' => $signature],
    'body' => $body,
]);

cURL

curl -X POST https://api.postal.so/crm-connections/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/preview \
  -H "Authorization: Bearer $POSTAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "payload": {
      "data": {
        "items": [
          {
            "person": {
              "id": 7,
              "mail": "[email protected]",
              "name": "Ana"
            },
            "deal": {
              "stage": "Won"
            },
            "labels": "vip, quente"
          }
        ]
      }
    },
    "settings": {
      "inbound": {
        "items_path": "$.data.items[*]"
      },
      "field_mappings": [
        {
          "crm_field": "$.person.mail",
          "postal_field": "email"
        },
        {
          "crm_field": "$.person.id",
          "postal_field": "crm_id"
        },
        {
          "crm_field": "person.name",
          "postal_field": "first_name"
        },
        {
          "crm_field": "$.labels",
          "postal_field": "tags"
        }
      ],
      "stage": {
        "crm_field": "$.deal.stage",
        "mappings": [
          {
            "stage": "won",
            "property_key": "lifecycle",
            "property_value": "customer",
            "tag": "customer"
          }
        ]
      }
    }
  }'

Node.js

const response = await fetch('https://api.postal.so/crm-connections/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/preview', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.POSTAL_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    payload: {
      data: {
        items: [
          {
            person: {
              id: 7,
              mail: '[email protected]',
              name: 'Ana',
            },
            deal: {
              stage: 'Won',
            },
            labels: 'vip, quente',
          },
        ],
      },
    },
    settings: {
      inbound: {
        items_path: '$.data.items[*]',
      },
      field_mappings: [
        {
          crm_field: '$.person.mail',
          postal_field: 'email',
        },
        {
          crm_field: '$.person.id',
          postal_field: 'crm_id',
        },
        {
          crm_field: 'person.name',
          postal_field: 'first_name',
        },
        {
          crm_field: '$.labels',
          postal_field: 'tags',
        },
      ],
      stage: {
        crm_field: '$.deal.stage',
        mappings: [
          {
            stage: 'won',
            property_key: 'lifecycle',
            property_value: 'customer',
            tag: 'customer',
          },
        ],
      },
    },
  }),
});

const data = await response.json();

Python

import os
import requests

response = requests.post(
    "https://api.postal.so/crm-connections/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/preview",
    headers={"Authorization": f"Bearer {os.environ['POSTAL_API_KEY']}"},
    json={
        "payload": {
            "data": {
                "items": [
                    {
                        "person": {
                            "id": 7,
                            "mail": "[email protected]",
                            "name": "Ana",
                        },
                        "deal": {
                            "stage": "Won",
                        },
                        "labels": "vip, quente",
                    },
                ],
            },
        },
        "settings": {
            "inbound": {
                "items_path": "$.data.items[*]",
            },
            "field_mappings": [
                {
                    "crm_field": "$.person.mail",
                    "postal_field": "email",
                },
                {
                    "crm_field": "$.person.id",
                    "postal_field": "crm_id",
                },
                {
                    "crm_field": "person.name",
                    "postal_field": "first_name",
                },
                {
                    "crm_field": "$.labels",
                    "postal_field": "tags",
                },
            ],
            "stage": {
                "crm_field": "$.deal.stage",
                "mappings": [
                    {
                        "stage": "won",
                        "property_key": "lifecycle",
                        "property_value": "customer",
                        "tag": "customer",
                    },
                ],
            },
        },
    },
    timeout=10,
)

data = response.json()

PHP

$client = new \GuzzleHttp\Client(['base_uri' => 'https://api.postal.so']);

$response = $client->post('crm-connections/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/preview', [
    'headers' => ['Authorization' => 'Bearer '.getenv('POSTAL_API_KEY')],
    'json' => [
        'payload' => [
            'data' => [
                'items' => [
                    [
                        'person' => [
                            'id' => 7,
                            'mail' => '[email protected]',
                            'name' => 'Ana',
                        ],
                        'deal' => [
                            'stage' => 'Won',
                        ],
                        'labels' => 'vip, quente',
                    ],
                ],
            ],
        ],
        'settings' => [
            'inbound' => [
                'items_path' => '$.data.items[*]',
            ],
            'field_mappings' => [
                [
                    'crm_field' => '$.person.mail',
                    'postal_field' => 'email',
                ],
                [
                    'crm_field' => '$.person.id',
                    'postal_field' => 'crm_id',
                ],
                [
                    'crm_field' => 'person.name',
                    'postal_field' => 'first_name',
                ],
                [
                    'crm_field' => '$.labels',
                    'postal_field' => 'tags',
                ],
            ],
            'stage' => [
                'crm_field' => '$.deal.stage',
                'mappings' => [
                    [
                        'stage' => 'won',
                        'property_key' => 'lifecycle',
                        'property_value' => 'customer',
                        'tag' => 'customer',
                    ],
                ],
            ],
        ],
    ],
]);

$data = json_decode($response->getBody(), true);

Node.js

import crypto from 'node:crypto';
import express from 'express';

const app = express();
const secret = process.env.POSTAL_CRM_SECRET; // o segredo da conexão (whsec_…)

app.post('/postal', express.raw({ type: 'application/json' }), (req, res) => {
  // req.body: o corpo cru, antes do JSON.parse
  const expected = 'sha256=' + crypto.createHmac('sha256', secret).update(req.body).digest('hex');
  const received = req.get('X-Postal-Signature') || '';

  if (received.length !== expected.length || !crypto.timingSafeEqual(Buffer.from(received), Buffer.from(expected))) {
    return res.sendStatus(401);
  }

  const { type, data } = JSON.parse(req.body);
  // type: contact.updated, email.opened, ... | data: o registro ou a atividade

  res.json({ id: '51' }); // opcional: o ID da pessoa no seu sistema
});

Python

import hashlib
import hmac
import os

from flask import Flask, abort, jsonify, request

app = Flask(__name__)
SECRET = os.environ["POSTAL_CRM_SECRET"]  # o segredo da conexão (whsec_…)

@app.post("/postal")
def postal():
    body = request.get_data()  # bytes, exatamente como chegaram
    expected = "sha256=" + hmac.new(SECRET.encode(), body, hashlib.sha256).hexdigest()

    if not hmac.compare_digest(request.headers.get("X-Postal-Signature", ""), expected):
        abort(401)

    event = request.get_json()  # event["type"], event["data"]
    return jsonify(id="51")  # opcional: o ID da pessoa no seu sistema

PHP

<?php

$secret = getenv('POSTAL_CRM_SECRET'); // o segredo da conexão (whsec_…)
$body = file_get_contents('php://input'); // o corpo cru
$expected = 'sha256='.hash_hmac('sha256', $body, $secret);

if (! hash_equals($expected, $_SERVER['HTTP_X_POSTAL_SIGNATURE'] ?? '')) {
    http_response_code(401);
    exit;
}

$event = json_decode($body, true); // $event['type'], $event['data']

header('Content-Type: application/json');
echo json_encode(['id' => '51']); // opcional: o ID da pessoa no seu sistema