Using locize
Guides / Tips & Tricks
Webhook
Get directly notified on a webhook url if something noticeable happens.
To enable this service go to settings, select the services tab and configure your endpoint. Make sure you have a secure https endpoint.
The following messages will be sent as json payload with a POST request.
All messages will have the following structure:
1
{
2
"id":"830fbcbb-90b7-4f0f-86bb-c82b55aab385", // the message id
3
"name":"dummyTestEvent", // the message name
4
"occurredAt":"2018-01-02T20:05:59.008Z", // the moment when this message occurred in ISO 8601 format
5
"message":"William Timberland just added a webhook to THIS PROJECT!", // a descriptive text of this message
6
"payload":{ // a variable payload
7
"messageTypes":[
8
"languageAdded",
9
"languageDeleted",
10
"versionAdded",
11
"versionDeleted",
12
"referenceLanguageChanged",
13
"orderCreated",
14
"orderCompleted",
15
"invitationAccepted",
16
"versionPublished",
17
"versionOverwrote",
18
"languageOverwrote",
19
"namespaceAdded",
20
"namespaceDeleted",
21
"namespaceCompleted",
22
"namespaceNotCompletedAnymore"
23
]
24
},
25
"meta":{ // a meta object containing...
26
"project":{
27
"id":"23dad587-b3bf-4663-b15c-ad8d66213ac6", // the project id
28
"name":"THIS PROJECT", // the project name
29
"slug":"albo6dxk" // the project slug
30
},
31
"user":{ // if message issued by a user
32
"id":"ab075147-c7a3-45d2-9b24-739ae2ed948a", // the user id
33
"firstname":"William", // the user firstname
34
"lastname":"Timberland" // the user lastname
35
},
36
"link":"https://www.locize.app/p/albo6dxk/v/latest" // a link pointing to the locize client
37
}
38
}
Copied!
languageAdded
1
{
2
"id":"427cc4dd-adf5-4fb8-ad8d-8508f2788fe3",
3
"name":"languageAdded",
4
"occurredAt":"2018-01-02T21:27:11.326Z",
5
"message":"William Timberland added language de!",
6
"payload":{
7
"language":"de"
8
},
9
"meta":{
10
"project":{
11
"id":"23dad587-b3bf-4663-b15c-ad8d66213ac6",
12
"name":"THIS PROJECT",
13
"slug":"albo6dxk"
14
},
15
"user":{
16
"id":"ab075147-c7a3-45d2-9b24-739ae2ed948a",
17
"firstname":"William",
18
"lastname":"Timberland"
19
},
20
"link":"https://www.locize.app/p/albo6dxk/v/latest"
21
}
22
}
Copied!
languageDeleted
1
{
2
"id":"427cc4dd-adf5-4fb8-ad8d-8508f2788fe3",
3
"name":"languageDeleted",
4
"occurredAt":"2018-01-02T21:27:11.326Z",
5
"message":"William Timberland removed language de!",
6
"payload":{
7
"language":"de"
8
},
9
"meta":{
10
"project":{
11
"id":"23dad587-b3bf-4663-b15c-ad8d66213ac6",
12
"name":"THIS PROJECT",
13
"slug":"albo6dxk"
14
},
15
"user":{
16
"id":"ab075147-c7a3-45d2-9b24-739ae2ed948a",
17
"firstname":"William",
18
"lastname":"Timberland"
19
},
20
"link":"https://www.locize.app/p/albo6dxk/v/latest"
21
}
22
}
Copied!
versionAdded
1
{
2
"id":"427cc4dd-adf5-4fb8-ad8d-8508f2788fe3",
3
"name":"versionAdded",
4
"occurredAt":"2018-01-02T21:27:11.326Z",
5
"message":"William Timberland added version prod!",
6
"payload":{
7
"version":"prod"
8
},
9
"meta":{
10
"project":{
11
"id":"23dad587-b3bf-4663-b15c-ad8d66213ac6",
12
"name":"THIS PROJECT",
13
"slug":"albo6dxk"
14
},
15
"user":{
16
"id":"ab075147-c7a3-45d2-9b24-739ae2ed948a",
17
"firstname":"William",
18
"lastname":"Timberland"
19
},
20
"link":"https://www.locize.app/p/albo6dxk/v/latest"
21
}
22
}
Copied!
versionDeleted
1
{
2
"id":"427cc4dd-adf5-4fb8-ad8d-8508f2788fe3",
3
"name":"versionDeleted",
4
"occurredAt":"2018-01-02T21:27:11.326Z",
5
"message":"William Timberland removed version prod!",
6
"payload":{
7
"version":"prod"
8
},
9
"meta":{
10
"project":{
11
"id":"23dad587-b3bf-4663-b15c-ad8d66213ac6",
12
"name":"THIS PROJECT",
13
"slug":"albo6dxk"
14
},
15
"user":{
16
"id":"ab075147-c7a3-45d2-9b24-739ae2ed948a",
17
"firstname":"William",
18
"lastname":"Timberland"
19
},
20
"link":"https://www.locize.app/p/albo6dxk/v/latest"
21
}
22
}
Copied!
referenceLanguageChanged
1
{
2
"id":"427cc4dd-adf5-4fb8-ad8d-8508f2788fe3",
3
"name":"referenceLanguageChanged",
4
"occurredAt":"2018-01-02T21:27:11.326Z",
5
"message":"William Timberland changed reference language from en to de!",
6
"payload":{
7
"from":"en",
8
"to":"de"
9
},
10
"meta":{
11
"project":{
12
"id":"23dad587-b3bf-4663-b15c-ad8d66213ac6",
13
"name":"THIS PROJECT",
14
"slug":"albo6dxk"
15
},
16
"user":{
17
"id":"ab075147-c7a3-45d2-9b24-739ae2ed948a",
18
"firstname":"William",
19
"lastname":"Timberland"
20
},
21
"link":"https://www.locize.app/p/albo6dxk/v/latest"
22
}
23
}
Copied!
orderCreated
1
{
2
"id":"427cc4dd-adf5-4fb8-ad8d-8508f2788fe3",
3
"name":"orderCreated",
4
"occurredAt":"2018-01-02T21:27:11.326Z",
5
"message":"William Timberland created a translation order with gengo!",
6
"payload":{
7
"service":"gengo",
8
"version":"latest"
9
},
10
"meta":{
11
"project":{
12
"id":"23dad587-b3bf-4663-b15c-ad8d66213ac6",
13
"name":"THIS PROJECT",
14
"slug":"albo6dxk"
15
},
16
"user":{
17
"id":"ab075147-c7a3-45d2-9b24-739ae2ed948a",
18
"firstname":"William",
19
"lastname":"Timberland"
20
},
21
"link":"https://www.locize.app/p/albo6dxk/v/latest"
22
}
23
}
Copied!
orderCompleted
1
{
2
"id":"427cc4dd-adf5-4fb8-ad8d-8508f2788fe3",
3
"name":"orderCompleted",
4
"occurredAt":"2018-01-02T21:27:11.326Z",
5
"message":"gengo order completed!",
6
"payload":{
7
"service":"gengo",
8
"version":"latest"
9
},
10
"meta":{
11
"project":{
12
"id":"23dad587-b3bf-4663-b15c-ad8d66213ac6",
13
"name":"THIS PROJECT",
14
"slug":"albo6dxk"
15
},
16
"link":"https://www.locize.app/p/albo6dxk/orders"
17
}
18
}
Copied!
invitationAccepted
1
{
2
"id":"427cc4dd-adf5-4fb8-ad8d-8508f2788fe3",
3
"name":"invitationAccepted",
4
"occurredAt":"2018-01-02T21:27:11.326Z",
5
"message":"William Timberland accepted the invitation and is now part of your project!",
6
"payload":{},
7
"meta":{
8
"project":{
9
"id":"23dad587-b3bf-4663-b15c-ad8d66213ac6",
10
"name":"THIS PROJECT",
11
"slug":"albo6dxk"
12
},
13
"user":{
14
"id":"ab075147-c7a3-45d2-9b24-739ae2ed948a",
15
"firstname":"William",
16
"lastname":"Timberland"
17
},
18
"link":"https://www.locize.app/p/albo6dxk/v/latest"
19
}
20
}
Copied!
versionPublished
1
{
2
"id":"427cc4dd-adf5-4fb8-ad8d-8508f2788fe3",
3
"name":"versionPublished",
4
"occurredAt":"2018-01-02T21:27:11.326Z",
5
"message":"William Timberland published version prod!",
6
"payload":{
7
"version":"prod"
8
},
9
"meta":{
10
"project":{
11
"id":"23dad587-b3bf-4663-b15c-ad8d66213ac6",
12
"name":"THIS PROJECT",
13
"slug":"albo6dxk"
14
},
15
"user":{
16
"id":"ab075147-c7a3-45d2-9b24-739ae2ed948a",
17
"firstname":"William",
18
"lastname":"Timberland"
19
},
20
"link":"https://www.locize.app/p/albo6dxk/v/prod"
21
}
22
}
Copied!
The versionPublished event will not be triggered when auto publish is enabled.
If you need to react on new translations, the events namespaceNotCompletedAnymore and namespaceCompeted might be an option.
versionOverwrote
1
{
2
"id":"427cc4dd-adf5-4fb8-ad8d-8508f2788fe3",
3
"name":"versionOverwrote",
4
"occurredAt":"2018-01-02T21:27:11.326Z",
5
"message":"William Timberland overwrote version prod with test!",
6
"payload":{
7
"from":"test",
8
"to":"prod"
9
},
10
"meta":{
11
"project":{
12
"id":"23dad587-b3bf-4663-b15c-ad8d66213ac6",
13
"name":"THIS PROJECT",
14
"slug":"albo6dxk"
15
},
16
"user":{
17
"id":"ab075147-c7a3-45d2-9b24-739ae2ed948a",
18
"firstname":"William",
19
"lastname":"Timberland"
20
},
21
"link":"https://www.locize.app/p/albo6dxk/v/prod"
22
}
23
}
Copied!
languageOverwrote
1
{
2
"id":"427cc4dd-adf5-4fb8-ad8d-8508f2788fe3",
3
"name":"languageOverwrote",
4
"occurredAt":"2018-01-02T21:27:11.326Z",
5
"message":"William Timberland overwrote language en version in version prod with test!",
6
"payload":{
7
"from":"test",
8
"to":"prod",
9
"language":"en"
10
},
11
"meta":{
12
"project":{
13
"id":"23dad587-b3bf-4663-b15c-ad8d66213ac6",
14
"name":"THIS PROJECT",
15
"slug":"albo6dxk"
16
},
17
"user":{
18
"id":"ab075147-c7a3-45d2-9b24-739ae2ed948a",
19
"firstname":"William",
20
"lastname":"Timberland"
21
},
22
"link":"https://www.locize.app/p/albo6dxk/v/prod"
23
}
24
}
Copied!
namespaceAdded
1
{
2
"id":"427cc4dd-adf5-4fb8-ad8d-8508f2788fe3",
3
"name":"namespaceAdded",
4
"occurredAt":"2018-01-02T21:27:11.326Z",
5
"message":"William Timberland added namespace landingpage in version latest!",
6
"payload":{
7
"namespace":"landingpage",
8
"version":"latest"
9
},
10
"meta":{
11
"project":{
12
"id":"23dad587-b3bf-4663-b15c-ad8d66213ac6",
13
"name":"THIS PROJECT",
14
"slug":"albo6dxk"
15
},
16
"user":{
17
"id":"ab075147-c7a3-45d2-9b24-739ae2ed948a",
18
"firstname":"William",
19
"lastname":"Timberland"
20
},
21
"link":"https://www.locize.app/p/albo6dxk/v/latest"
22
}
23
}
Copied!
namespaceDeleted
1
{
2
"id":"427cc4dd-adf5-4fb8-ad8d-8508f2788fe3",
3
"name":"namespaceDeleted",
4
"occurredAt":"2018-01-02T21:27:11.326Z",
5
"message":"William Timberland removed namespace landingpage in version latest!",
6
"payload":{
7
"namespace":"landingpage",
8
"version":"latest"
9
},
10
"meta":{
11
"project":{
12
"id":"23dad587-b3bf-4663-b15c-ad8d66213ac6",
13
"name":"THIS PROJECT",
14
"slug":"albo6dxk"
15
},
16
"user":{
17
"id":"ab075147-c7a3-45d2-9b24-739ae2ed948a",
18
"firstname":"William",
19
"lastname":"Timberland"
20
},
21
"link":"https://www.locize.app/p/albo6dxk/v/latest"
22
}
23
}
Copied!
namespaceCompleted
1
{
2
"id":"427cc4dd-adf5-4fb8-ad8d-8508f2788fe3",
3
"name":"namespaceCompleted",
4
"occurredAt":"2018-01-02T21:27:11.326Z",
5
"message":"Translation of namespace landingpage in language en for version latest completed!",
6
"payload":{
7
"namespace":"landingpage",
8
"language":"en",
9
"version":"latest"
10
},
11
"meta":{
12
"project":{
13
"id":"23dad587-b3bf-4663-b15c-ad8d66213ac6",
14
"name":"THIS PROJECT",
15
"slug":"albo6dxk"
16
},
17
"link":"https://www.locize.app/p/albo6dxk/v/latest/en/landingpage"
18
}
19
}
Copied!
namespaceNotCompletedAnymore
1
{
2
"id":"427cc4dd-adf5-4fb8-ad8d-8508f2788fe3",
3
"name":"namespaceNotCompletedAnymore",
4
"occurredAt":"2018-01-02T21:27:11.326Z",
5
"message":"New segments of namespace landingpage ready to be translated in language en for version latest!",
6
"payload":{
7
"namespace":"landingpage",
8
"language":"en",
9
"version":"latest"
10
},
11
"meta":{
12
"project":{
13
"id":"23dad587-b3bf-4663-b15c-ad8d66213ac6",
14
"name":"THIS PROJECT",
15
"slug":"albo6dxk"
16
},
17
"link":"https://www.locize.app/p/albo6dxk/v/latest/en/landingpage"
18
}
19
}
Copied!
Last modified 2d ago