CRM360° CustomerApi Documentation
Return to Web Api Help Page

Webhook - QueueProcess

Send request in asynchronous message process with webhook content (headers / Uri / Body)

URI Parameters

Name Description Type Additional information
CustomerName

CRM360 CustomerName

string

Required

DatabaseAlias

CRM360 DatabaseAlias

string

Required

ExternalPlatform

External webhook origin

string

Required

ExternalEntity

External webhook concerning entity

string

Required

ExternalAction

External webhook action

string

Required

SourceId

CRM360 Source Id corresponding to the External Webhook Origin

integer

Required

ZoneId

CRM360 Zone Id on which data must be attached

integer
BrandId

CRM360 Brand Id on which data must be attached

integer
ContactAddressTypeId

CRM360 Contact Address Type Id on which data must be attached

integer
BatchMode

Activate heavy load of data through webhook

boolean

Default value is False

Email

send the webhook content to the specified email if not null

string
secondsOfInvisibility

delay of message invisibility in queue

integer

Body Parameters

Example

Available parameters Value

 
              ExternalPlatform : "Shopify", ExternalEntity : "Customer", ExternalAction : "Insert"
              ExternalPlatform : "Shopify", ExternalEntity : "Customer", ExternalAction : "Update"
              ExternalPlatform : "Shopify", ExternalEntity : "Customer", ExternalAction : "Delete"
              ExternalPlatform : "Shopify", ExternalEntity : "Product", ExternalAction : "Insert"
              ExternalPlatform : "Shopify", ExternalEntity : "Product", ExternalAction : "Update"
              ExternalPlatform : "Shopify", ExternalEntity : "Product", ExternalAction : "Delete"
              ExternalPlatform : "Shopify", ExternalEntity : "Order", ExternalAction : "Insert"
              ExternalPlatform : "Shopify", ExternalEntity : "Order", ExternalAction : "Update"
              ExternalPlatform : "Shopify", ExternalEntity : "Order", ExternalAction : "Delete"
            
              ExternalPlatform : "Adictiz", ExternalEntity : "User", ExternalAction : "Participate"
              
              ExternalPlatform : "Primotexto", ExternalEntity : "Sms", ExternalAction : "Callback"
              
              ExternalPlatform : "Smsbox", ExternalEntity : "Sms", ExternalAction : "Callback"
              ExternalPlatform : "Smsbox", ExternalEntity : "Sms", ExternalAction : "CallbackStop"
              
              ExternalPlatform : "Mailjet", ExternalEntity : "email", ExternalAction : "Callback"
              
              ExternalPlatform : "elfy76310", ExternalEntity : "process", ExternalAction : "Rnvp"
              ExternalPlatform : "elfy76310", ExternalEntity : "process", ExternalAction : "RnvpDedup"
              
              ExternalPlatform : "Zendesk", ExternalEntity : "Ticket", ExternalAction : "Update"                     
                                 Request Body : 
                                 {
                                     "via" : "{{ticket.via}}",
                                 	"title" : "{{ticket.title}}",
                                 	"id" : "{{ticket.id}}",
                                 	"link" : "{{ticket.link}}",
                                 	"status" : "{{ticket.status}}",
                                 	"type" : "{{ticket.ticket_type}}",
                                 	"comments" : "{{ticket.comments_formatted}}",
                                 	"requester" : {
                                 		"first_name" : "{{ticket.requester.first_name}}",
                                 		"last_name" : "{{ticket.requester.last_name}}",
                                 		"email" : "{{ticket.requester.email}}",
                                 		"phone" : "{{ticket.requester.phone}}"
                                 	}
                                 }    
                                 
             
             
              ExternalPlatform : "Tabology", ExternalEntity : "Ticket", ExternalAction : "Update"    
              ExternalPlatform : "Tabology", ExternalEntity : "Ticket", ExternalAction : "Create"
                                 Additionnal parameters in URI : 
                                     - store= put here the store identifier from tabology
                                     - currency = put here the used currency
             
             
              ExternalPlatform : "Crm360", ExternalEntity : "Sms", ExternalAction : "Send"
                                 Request Body : 
                                 {
                                     MobilePhoneNumber : "0600000000"
                                     MobilePhoneCountryIso3 : "FRA",
                                     Sender : "CRM360",
                                     Message : "Mon SMS",
                                     Crm360EventChannelId : "1",
                                     Crm360EventCategoryId : "1"
                                 }    
                                 
             
              ExternalPlatform : "Crm360", ExternalEntity : "Email", ExternalAction : "Send"
                                 Request Body : 
                                 {
                                     EmailTo: "ndestroye@fts-services.com",
                                     SenderEmail: "contact@fts-services.com",
                                     SenderAlias: "CRM360",
                                     ReplyTo : "support@fts-services.Com",
                                     Subject: "Bonjour {{var:Prenom}}",
                                     HtmlMessage: "Bonjour {{var:Prenom}}",
                                     TextMessage: "Bonjour {{var:Prenom}}",
                                     VariablePersoJson: {
                                     	Prenom: "Nicolas",
                                     	Nom: "Destroye"
                                     }
                                 }  
                                 
              ExternalPlatform : "CaptainWallet", ExternalEntity : "LoyaltyCard", ExternalAction : "SendUpdate"
                                 Request Body : 
                                 {
                                     LoyaltyCardId: "12345"
                                 }  
             

Response Information

- IHttpActionResult

application/json

Sample not available.