Webhook

post

Handle message status updates from Twilio.

Authorizations
Body
idstring · uuidRead-onlyRequired
userall ofRead-onlyRequired
recipientsstringRead-onlyRequired
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableOptional
updated_atstring · date-timeRead-onlyRequired
transaction_idintegerRead-onlyRequired
creditsinteger · min: -2147483648 · max: 2147483647Required
valid_recipients_countinteger · max: 2147483647Optional
invalid_recipients_countinteger · max: 2147483647Optional
message_contentstring | nullableOptional
media_urlsany | nullableOptional
voice_urlstring · uri | nullableOptional
send_atstring · date-time | nullableOptional
sender_phonestring | nullableOptional
sender_emailstring · email | nullableOptional
sender_namestring · email | nullableOptional
typestring · enumOptional
  • sms - SMS
  • mms - MMS
  • voice - Voice
  • push_notification - Push Notification
  • email - Email
Possible values:
statusstring · enumOptional
  • scheduled - Scheduled
  • sent - Sent
  • failed - Failed
Possible values:
message_typestring · enumRequired
  • personalize_message - Personalize Message
  • general_message - General Message
Possible values:
celery_task_idstring | nullableOptional
subjectstring | nullableOptional
target_pagestring | nullableOptional
churchstring · uuidRequired
Responses
200Success
application/json
post
POST /api/unified-communications/message-transactions/webhook HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 535

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:14:27.590Z",
  "credits": 1,
  "valid_recipients_count": 1,
  "invalid_recipients_count": 1,
  "message_content": "text",
  "media_urls": null,
  "voice_url": "https://example.com",
  "send_at": "2025-07-23T12:14:27.590Z",
  "sender_phone": "text",
  "sender_email": "[email protected]",
  "sender_name": "[email protected]",
  "type": "sms",
  "status": "scheduled",
  "message_type": "personalize_message",
  "celery_task_id": "text",
  "subject": "text",
  "target_page": "text",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "recipients": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:14:27.590Z",
  "updated_at": "2025-07-23T12:14:27.590Z",
  "transaction_id": 1,
  "credits": 1,
  "valid_recipients_count": 1,
  "invalid_recipients_count": 1,
  "message_content": "text",
  "media_urls": null,
  "voice_url": "https://example.com",
  "send_at": "2025-07-23T12:14:27.590Z",
  "sender_phone": "text",
  "sender_email": "[email protected]",
  "sender_name": "[email protected]",
  "type": "sms",
  "status": "scheduled",
  "message_type": "personalize_message",
  "celery_task_id": "text",
  "subject": "text",
  "target_page": "text",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}
PreviousMessage transactionsNextSmart keyword