Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.propaga.mx/llms.txt

Use this file to discover all available pages before exploring further.

​
Webhook Endpoint

You should configure your webhook endpoint to receive POST requests from Propaga. The webhook will send the user data in JSON format. Please contact us to set up the webhook.

​
Payload Structure

Here’s an example of the webhook payload you’ll receive: 
{
  "id": "563249dd-6fc6-4d85-8ac7-42114ba8cf80",
  "userId": "671f75a4-f145-4f4b-82ff-4eaf0fd1e5aa",
  "externalId": "123456789",
  "status": "validated",
}

​
Payload Fields

FieldTypeDescription
idStringThe ID of the user activation.
userIdStringThe Propaga’s ID of the user.
externalIdStringThe ID of the user in your system.
statusStringThe status of the user activation.

​
Handling the Webhook

Here’s an example of how to handle the webhook in different programming languages: 
app.post('/webhook/user-activation', async (req, res) => {
  try {
    const userActivation = req.body;
    
    // Process the user activation data
    await processUserActivation(userActivation);
    
    // Respond with success
    res.status(200).json({ status: 'success' });
  } catch (error) {
    console.error('Error processing user activation:', error);
    res.status(500).json({ status: 'error', message: error.message });
  }
});

async function processUserActivation(userActivation) {
  // Validate the user activation
  console.log(`Processing user activation: ${userActivation.id}`);
  console.log(`Status: ${userActivation.status}`);
  
  // Process each transaction
  console.log(`User ID: ${userActivation.userId}`);
  console.log(`External ID: ${userActivation.externalId}`);
}

​
Best Practices

  1. Verify the Webhook Source: Implement security measures to verify that the webhook is coming from Propaga.
  2. Implement Idempotency: Store the referenceNumber to avoid processing the same conciliation multiple times.
  3. Handle Errors Gracefully: Implement proper error handling and logging to track any issues with webhook processing.
  4. Respond Quickly: Your webhook endpoint should respond as quickly as possible. If processing takes time, handle it asynchronously.
  5. Validate Data: Always validate the incoming data before processing it.